From 15d5ab2700459e4cb382ae21d1dc43bd7ec154cf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Le=C5=9Bniak?= Date: Wed, 6 Aug 2025 12:10:04 +0200 Subject: [PATCH] RDoc-3361 Fixed anchors containing dots --- cloud/cloud-instances.mdx | 4 +- cloud/cloud-overview.mdx | 2 +- cloud/cloud-security.mdx | 2 +- cloud/portal/cloud-portal-products-tab.mdx | 8 +- .../connection-strings/azure-open-ai.mdx | 2 +- .../connection-strings/embedded.mdx | 2 +- .../connection-strings/google-ai.mdx | 2 +- .../connection-strings/hugging-face.mdx | 2 +- .../connection-strings/mistral-ai.mdx | 2 +- .../connection-strings/ollama.mdx | 2 +- .../connection-strings/open-ai.mdx | 2 +- .../generating-embeddings/overview.mdx | 8 +- .../vector-search-using-dynamic-query.mdx | 18 +- .../vector-search-using-static-index.mdx | 10 +- .../what-affects-vector-search-results.mdx | 8 +- .../changes/what-is-changes-api.mdx | 6 +- docs/client-api/configuration/conventions.mdx | 4 +- .../configuration/serialization.mdx | 2 +- .../consumption/api-overview.mdx | 4 +- .../client-api/faq/backward-compatibility.mdx | 10 +- .../operations/common/delete-by-query.mdx | 8 +- .../include-compare-exchange.mdx | 2 +- .../operations/compare-exchange/overview.mdx | 6 +- ...tch-operations-to-a-different-database.mdx | 14 +- .../maintenance/backup/backup-overview.mdx | 2 +- .../operations/patching/single-document.mdx | 4 +- .../cluster-transaction/atomic-guards.mdx | 8 +- .../session/cluster-transaction/overview.mdx | 8 +- docs/client-api/session/opening-a-session.mdx | 8 +- .../document-query/what-is-document-query.mdx | 6 +- .../querying/how-to-make-a-spatial-query.mdx | 6 +- .../querying/how-to-project-query-results.mdx | 16 +- .../session/querying/how-to-query.mdx | 64 +++---- .../querying/how-to-stream-query-results.mdx | 4 +- .../session/querying/sort-query-results.mdx | 6 +- docs/client-api/session/updating-entities.mdx | 8 +- ...what-is-a-session-and-how-does-it-work.mdx | 10 +- .../archived-documents-and-other-features.mdx | 16 +- docs/data-archival/unarchiving-documents.mdx | 6 +- .../counters/counters-and-other-features.mdx | 14 +- .../revisions/client-api/overview.mdx | 6 +- .../revisions/overview.mdx | 8 +- .../session/include/with-raw-queries.mdx | 4 +- .../client-api/javascript-support.mdx | 6 +- .../client-api/session/delete.mdx | 2 +- .../client-api/session/get.mdx | 2 +- .../client-api/session/increment.mdx | 2 +- .../incremental-time-series/overview.mdx | 2 +- .../timeseries/querying/stream-timeseries.mdx | 4 +- docs/indexes/boosting.mdx | 8 +- docs/indexes/creating-and-deploying.mdx | 12 +- docs/indexes/index-administration.mdx | 10 +- docs/indexes/index-throttling.mdx | 6 +- docs/indexes/indexing-basics.mdx | 12 +- docs/indexes/indexing-nested-data.mdx | 8 +- docs/indexes/javascript-indexes.mdx | 4 +- docs/indexes/map-indexes.mdx | 16 +- docs/indexes/querying/exploration-queries.mdx | 14 +- docs/indexes/querying/paging.mdx | 10 +- docs/indexes/querying/query-index.mdx | 14 +- docs/indexes/rolling-index-deployment.mdx | 2 +- docs/indexes/search-engine/corax.mdx | 30 ++-- docs/indexes/using-analyzers.mdx | 24 +-- .../integrating-with-akka-persistence.mdx | 2 +- .../postgresql-protocol/overview.mdx | 4 +- .../client-api/client-breaking-changes.mdx | 2 +- .../migration/client-api/client-migration.mdx | 2 +- docs/migration/server/data-migration.mdx | 12 +- docs/migration/server/docker.mdx | 4 +- docs/server/administration/cli.mdx | 2 +- .../monitoring/open-telemetry.mdx | 36 ++-- .../administration/snmp/snmp-overview.mdx | 26 +-- .../distribution/cluster-observer.mdx | 8 +- .../distribution/distributed-database.mdx | 4 +- .../distribution/highly-available-tasks.mdx | 2 +- .../ai-integration-configuration.mdx | 6 +- .../configuration/backup-configuration.mdx | 16 +- .../configuration/cluster-configuration.mdx | 46 ++--- .../configuration/configuration-options.mdx | 8 +- .../configuration/core-configuration.mdx | 4 +- .../configuration/database-configuration.mdx | 26 +-- .../configuration/etl-configuration.mdx | 20 +-- .../configuration/http-configuration.mdx | 34 ++-- .../configuration/indexing-configuration.mdx | 166 +++++++++--------- .../configuration/license-configuration.mdx | 2 +- .../configuration/logs-configuration.mdx | 34 ++-- .../monitoring-configuration.mdx | 74 ++++---- .../configuration/patching-configuration.mdx | 6 +- .../performance-hints-configuration.mdx | 18 +- .../queue-sink-configuration.mdx | 4 +- .../configuration/security-configuration.mdx | 108 ++++++------ .../configuration/server-configuration.mdx | 12 +- .../configuration/storage-configuration.mdx | 2 +- .../subscription-configuration.mdx | 4 +- docs/server/embedded.mdx | 2 +- docs/server/kb/javascript-engine.mdx | 4 +- docs/server/ongoing-tasks/etl/basics.mdx | 10 +- docs/server/ongoing-tasks/etl/olap.mdx | 2 +- .../etl/queue-etl/azure-queue.mdx | 2 +- docs/server/ongoing-tasks/etl/sql.mdx | 2 +- .../queue-sink/kafka-queue-sink.mdx | 4 +- .../queue-sink/rabbit-mq-queue-sink.mdx | 4 +- .../security/audit-log/audit-log-overview.mdx | 12 +- .../certificate-configuration.mdx | 4 +- .../security-clearance-and-permissions.mdx | 2 +- .../server/security/common-errors-and-faq.mdx | 6 +- .../encryption/database-encryption.mdx | 2 +- .../encryption/encryption-at-rest.mdx | 4 +- ...customizing-raven-data-files-locations.mdx | 14 +- docs/server/storage/documents-compression.mdx | 4 +- docs/server/tcp-compression.mdx | 2 +- docs/server/troubleshooting/collect-info.mdx | 12 +- docs/server/troubleshooting/logging.mdx | 18 +- docs/sharding/overview.mdx | 2 +- .../containers/requirements/security.mdx | 10 +- docs/start/getting-started.mdx | 6 +- .../deployment-considerations.mdx | 2 +- docs/start/installation/manual.mdx | 4 +- .../setup-examples/aws-linux-vm.mdx | 4 +- docs/start/installation/setup-wizard.mdx | 4 +- .../installation/upgrading-to-new-version.mdx | 4 +- docs/start/licensing/activate-license.mdx | 2 +- docs/start/licensing/force-update.mdx | 4 +- docs/start/licensing/renew-license.mdx | 4 +- docs/start/licensing/replace-license.mdx | 4 +- .../create-new-database/from-backup.mdx | 2 +- .../create-new-database/from-legacy-files.mdx | 6 +- .../create-new-database/general-flow.mdx | 12 +- docs/studio/database/documents/patch-view.mdx | 2 +- .../database/indexes/indexing-performance.mdx | 14 +- .../database/settings/database-settings.mdx | 4 +- .../settings/documents-compression.mdx | 2 +- .../settings/studio-configuration.mdx | 12 +- .../database/tasks/create-sample-data.mdx | 2 +- .../tasks/import-data/import-from-other.mdx | 6 +- .../server-management-certificates-view.mdx | 2 +- docs/studio/server/server-settings.mdx | 2 +- .../changes/what-is-changes-api.mdx | 6 +- .../client-api/configuration/conventions.mdx | 4 +- .../configuration/serialization.mdx | 2 +- .../consumption/api-overview.mdx | 4 +- .../client-api/faq/backward-compatibility.mdx | 10 +- .../operations/common/delete-by-query.mdx | 8 +- .../include-compare-exchange.mdx | 2 +- .../operations/compare-exchange/overview.mdx | 6 +- ...tch-operations-to-a-different-database.mdx | 14 +- .../maintenance/backup/backup-overview.mdx | 2 +- .../operations/patching/single-document.mdx | 4 +- .../cluster-transaction/atomic-guards.mdx | 8 +- .../session/cluster-transaction/overview.mdx | 8 +- .../client-api/session/opening-a-session.mdx | 8 +- .../document-query/what-is-document-query.mdx | 6 +- .../querying/how-to-make-a-spatial-query.mdx | 6 +- .../querying/how-to-project-query-results.mdx | 16 +- .../session/querying/how-to-query.mdx | 64 +++---- .../querying/how-to-stream-query-results.mdx | 4 +- .../session/querying/sort-query-results.mdx | 6 +- .../client-api/session/updating-entities.mdx | 8 +- ...what-is-a-session-and-how-does-it-work.mdx | 10 +- .../archived-documents-and-other-features.mdx | 16 +- .../data-archival/unarchiving-documents.mdx | 6 +- .../counters/counters-and-other-features.mdx | 14 +- .../revisions/client-api/overview.mdx | 6 +- .../revisions/overview.mdx | 8 +- .../session/include/with-raw-queries.mdx | 4 +- .../client-api/javascript-support.mdx | 6 +- .../client-api/session/delete.mdx | 2 +- .../client-api/session/get.mdx | 2 +- .../client-api/session/increment.mdx | 2 +- .../incremental-time-series/overview.mdx | 2 +- .../timeseries/querying/stream-timeseries.mdx | 4 +- .../version-6.2/indexes/boosting.mdx | 8 +- .../indexes/creating-and-deploying.mdx | 12 +- .../indexes/index-administration.mdx | 10 +- .../version-6.2/indexes/index-throttling.mdx | 6 +- .../version-6.2/indexes/indexing-basics.mdx | 12 +- .../indexes/indexing-nested-data.mdx | 8 +- .../indexes/javascript-indexes.mdx | 4 +- .../version-6.2/indexes/map-indexes.mdx | 16 +- .../indexes/querying/exploration-queries.mdx | 14 +- .../version-6.2/indexes/querying/paging.mdx | 10 +- .../indexes/querying/query-index.mdx | 14 +- .../indexes/rolling-index-deployment.mdx | 2 +- .../indexes/search-engine/corax.mdx | 30 ++-- .../version-6.2/indexes/using-analyzers.mdx | 24 +-- .../integrating-with-akka-persistence.mdx | 2 +- .../postgresql-protocol/overview.mdx | 4 +- .../client-api/client-breaking-changes.mdx | 2 +- .../migration/server/data-migration.mdx | 10 +- .../version-6.2/migration/server/docker.mdx | 4 +- .../server/server-breaking-changes.mdx | 2 +- .../version-6.2/server/administration/cli.mdx | 2 +- .../monitoring/open-telemetry.mdx | 36 ++-- .../administration/snmp/snmp-overview.mdx | 26 +-- .../distribution/cluster-observer.mdx | 8 +- .../distribution/distributed-database.mdx | 4 +- .../distribution/highly-available-tasks.mdx | 2 +- .../configuration/backup-configuration.mdx | 16 +- .../configuration/cluster-configuration.mdx | 46 ++--- .../configuration/configuration-options.mdx | 8 +- .../configuration/core-configuration.mdx | 4 +- .../configuration/database-configuration.mdx | 26 +-- .../configuration/etl-configuration.mdx | 20 +-- .../configuration/http-configuration.mdx | 34 ++-- .../configuration/indexing-configuration.mdx | 152 ++++++++-------- .../configuration/license-configuration.mdx | 2 +- .../monitoring-configuration.mdx | 74 ++++---- .../configuration/patching-configuration.mdx | 6 +- .../performance-hints-configuration.mdx | 18 +- .../queue-sink-configuration.mdx | 4 +- .../configuration/security-configuration.mdx | 108 ++++++------ .../configuration/server-configuration.mdx | 12 +- .../configuration/storage-configuration.mdx | 2 +- .../subscription-configuration.mdx | 4 +- .../version-6.2/server/embedded.mdx | 2 +- .../server/kb/javascript-engine.mdx | 4 +- .../server/ongoing-tasks/etl/basics.mdx | 10 +- .../server/ongoing-tasks/etl/olap.mdx | 2 +- .../etl/queue-etl/azure-queue.mdx | 2 +- .../server/ongoing-tasks/etl/sql.mdx | 2 +- .../queue-sink/kafka-queue-sink.mdx | 4 +- .../queue-sink/rabbit-mq-queue-sink.mdx | 4 +- .../security/audit-log/audit-log-overview.mdx | 10 +- .../certificate-configuration.mdx | 4 +- .../security-clearance-and-permissions.mdx | 2 +- .../server/security/common-errors-and-faq.mdx | 6 +- .../encryption/database-encryption.mdx | 2 +- .../encryption/encryption-at-rest.mdx | 4 +- ...customizing-raven-data-files-locations.mdx | 14 +- .../server/storage/documents-compression.mdx | 4 +- .../version-6.2/server/tcp-compression.mdx | 2 +- .../server/troubleshooting/collect-info.mdx | 12 +- .../version-6.2/sharding/overview.mdx | 2 +- .../containers/requirements/security.mdx | 10 +- .../version-6.2/start/getting-started.mdx | 6 +- .../deployment-considerations.mdx | 2 +- .../version-6.2/start/installation/manual.mdx | 4 +- .../setup-examples/aws-linux-vm.mdx | 4 +- .../start/installation/setup-wizard.mdx | 4 +- .../installation/upgrading-to-new-version.mdx | 4 +- .../start/licensing/activate-license.mdx | 2 +- .../start/licensing/force-update.mdx | 4 +- .../start/licensing/renew-license.mdx | 4 +- .../start/licensing/replace-license.mdx | 4 +- .../create-new-database/from-backup.mdx | 2 +- .../create-new-database/from-legacy-files.mdx | 6 +- .../create-new-database/general-flow.mdx | 12 +- .../studio/database/documents/patch-view.mdx | 2 +- .../database/indexes/indexing-performance.mdx | 14 +- .../database/settings/database-settings.mdx | 4 +- .../settings/documents-compression.mdx | 2 +- .../settings/studio-configuration.mdx | 12 +- .../database/tasks/create-sample-data.mdx | 2 +- .../tasks/import-data/import-from-other.mdx | 6 +- .../studio/server/server-settings.mdx | 2 +- .../connection-strings/azure-open-ai.mdx | 2 +- .../connection-strings/embedded.mdx | 2 +- .../connection-strings/google-ai.mdx | 2 +- .../connection-strings/hugging-face.mdx | 2 +- .../connection-strings/mistral-ai.mdx | 2 +- .../connection-strings/ollama.mdx | 2 +- .../connection-strings/open-ai.mdx | 2 +- .../generating-embeddings/overview.mdx | 8 +- .../vector-search-using-dynamic-query.mdx | 18 +- .../vector-search-using-static-index.mdx | 10 +- .../what-affects-vector-search-results.mdx | 8 +- .../changes/what-is-changes-api.mdx | 6 +- .../client-api/configuration/conventions.mdx | 4 +- .../configuration/serialization.mdx | 2 +- .../consumption/api-overview.mdx | 4 +- .../client-api/faq/backward-compatibility.mdx | 10 +- .../operations/common/delete-by-query.mdx | 8 +- .../include-compare-exchange.mdx | 2 +- .../operations/compare-exchange/overview.mdx | 6 +- ...tch-operations-to-a-different-database.mdx | 14 +- .../maintenance/backup/backup-overview.mdx | 2 +- .../operations/patching/single-document.mdx | 4 +- .../cluster-transaction/atomic-guards.mdx | 8 +- .../session/cluster-transaction/overview.mdx | 8 +- .../client-api/session/opening-a-session.mdx | 8 +- .../document-query/what-is-document-query.mdx | 6 +- .../querying/how-to-make-a-spatial-query.mdx | 6 +- .../querying/how-to-project-query-results.mdx | 16 +- .../session/querying/how-to-query.mdx | 64 +++---- .../querying/how-to-stream-query-results.mdx | 4 +- .../session/querying/sort-query-results.mdx | 6 +- .../client-api/session/updating-entities.mdx | 8 +- ...what-is-a-session-and-how-does-it-work.mdx | 10 +- .../archived-documents-and-other-features.mdx | 16 +- .../data-archival/unarchiving-documents.mdx | 6 +- .../counters/counters-and-other-features.mdx | 14 +- .../revisions/client-api/overview.mdx | 6 +- .../revisions/overview.mdx | 8 +- .../session/include/with-raw-queries.mdx | 4 +- .../client-api/javascript-support.mdx | 6 +- .../client-api/session/delete.mdx | 2 +- .../client-api/session/get.mdx | 2 +- .../client-api/session/increment.mdx | 2 +- .../incremental-time-series/overview.mdx | 2 +- .../timeseries/querying/stream-timeseries.mdx | 4 +- .../version-7.0/indexes/boosting.mdx | 8 +- .../indexes/creating-and-deploying.mdx | 12 +- .../indexes/index-administration.mdx | 10 +- .../version-7.0/indexes/index-throttling.mdx | 6 +- .../version-7.0/indexes/indexing-basics.mdx | 12 +- .../indexes/indexing-nested-data.mdx | 8 +- .../indexes/javascript-indexes.mdx | 4 +- .../version-7.0/indexes/map-indexes.mdx | 16 +- .../indexes/querying/exploration-queries.mdx | 14 +- .../version-7.0/indexes/querying/paging.mdx | 10 +- .../indexes/querying/query-index.mdx | 14 +- .../indexes/rolling-index-deployment.mdx | 2 +- .../indexes/search-engine/corax.mdx | 30 ++-- .../version-7.0/indexes/using-analyzers.mdx | 24 +-- .../integrating-with-akka-persistence.mdx | 2 +- .../postgresql-protocol/overview.mdx | 4 +- .../client-api/client-breaking-changes.mdx | 2 +- .../migration/client-api/client-migration.mdx | 2 +- .../migration/server/data-migration.mdx | 12 +- .../version-7.0/migration/server/docker.mdx | 4 +- .../version-7.0/server/administration/cli.mdx | 2 +- .../monitoring/open-telemetry.mdx | 36 ++-- .../administration/snmp/snmp-overview.mdx | 26 +-- .../distribution/cluster-observer.mdx | 8 +- .../distribution/distributed-database.mdx | 4 +- .../distribution/highly-available-tasks.mdx | 2 +- .../ai-integration-configuration.mdx | 6 +- .../configuration/backup-configuration.mdx | 16 +- .../configuration/cluster-configuration.mdx | 46 ++--- .../configuration/configuration-options.mdx | 8 +- .../configuration/core-configuration.mdx | 4 +- .../configuration/database-configuration.mdx | 26 +-- .../configuration/etl-configuration.mdx | 20 +-- .../configuration/http-configuration.mdx | 34 ++-- .../configuration/indexing-configuration.mdx | 166 +++++++++--------- .../configuration/license-configuration.mdx | 2 +- .../configuration/logs-configuration.mdx | 34 ++-- .../monitoring-configuration.mdx | 74 ++++---- .../configuration/patching-configuration.mdx | 6 +- .../performance-hints-configuration.mdx | 18 +- .../queue-sink-configuration.mdx | 4 +- .../configuration/security-configuration.mdx | 108 ++++++------ .../configuration/server-configuration.mdx | 12 +- .../configuration/storage-configuration.mdx | 2 +- .../subscription-configuration.mdx | 4 +- .../version-7.0/server/embedded.mdx | 2 +- .../server/kb/javascript-engine.mdx | 4 +- .../server/ongoing-tasks/etl/basics.mdx | 10 +- .../server/ongoing-tasks/etl/olap.mdx | 2 +- .../etl/queue-etl/azure-queue.mdx | 2 +- .../server/ongoing-tasks/etl/sql.mdx | 2 +- .../queue-sink/kafka-queue-sink.mdx | 4 +- .../queue-sink/rabbit-mq-queue-sink.mdx | 4 +- .../security/audit-log/audit-log-overview.mdx | 12 +- .../certificate-configuration.mdx | 4 +- .../security-clearance-and-permissions.mdx | 2 +- .../server/security/common-errors-and-faq.mdx | 6 +- .../encryption/database-encryption.mdx | 2 +- .../encryption/encryption-at-rest.mdx | 4 +- ...customizing-raven-data-files-locations.mdx | 14 +- .../server/storage/documents-compression.mdx | 4 +- .../version-7.0/server/tcp-compression.mdx | 2 +- .../server/troubleshooting/collect-info.mdx | 12 +- .../server/troubleshooting/logging.mdx | 18 +- .../version-7.0/sharding/overview.mdx | 2 +- .../containers/requirements/security.mdx | 10 +- .../version-7.0/start/getting-started.mdx | 6 +- .../deployment-considerations.mdx | 2 +- .../version-7.0/start/installation/manual.mdx | 4 +- .../setup-examples/aws-linux-vm.mdx | 4 +- .../start/installation/setup-wizard.mdx | 4 +- .../installation/upgrading-to-new-version.mdx | 4 +- .../start/licensing/activate-license.mdx | 2 +- .../start/licensing/force-update.mdx | 4 +- .../start/licensing/renew-license.mdx | 4 +- .../start/licensing/replace-license.mdx | 4 +- .../create-new-database/from-backup.mdx | 2 +- .../create-new-database/from-legacy-files.mdx | 6 +- .../create-new-database/general-flow.mdx | 12 +- .../studio/database/documents/patch-view.mdx | 2 +- .../database/indexes/indexing-performance.mdx | 14 +- .../database/settings/database-settings.mdx | 4 +- .../settings/documents-compression.mdx | 2 +- .../settings/studio-configuration.mdx | 12 +- .../database/tasks/create-sample-data.mdx | 2 +- .../tasks/import-data/import-from-other.mdx | 6 +- .../server-management-certificates-view.mdx | 2 +- .../studio/server/server-settings.mdx | 2 +- 388 files changed, 2079 insertions(+), 2079 deletions(-) diff --git a/cloud/cloud-instances.mdx b/cloud/cloud-instances.mdx index d21ef8b829..babb72c5ff 100644 --- a/cloud/cloud-instances.mdx +++ b/cloud/cloud-instances.mdx @@ -19,10 +19,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; - Use your portal's [Products tab](../cloud/portal/cloud-portal-products-tab.mdx) to raise or modify a Free node, a Development node, or a Production cluster. - 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/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 -[Reserved clusters](../cloud/cloud-overview.mdx#burstable-vs.-reserved-clusters). +[Reserved clusters](../cloud/cloud-overview.mdx#burstable-vs-reserved-clusters). In this page: diff --git a/cloud/cloud-overview.mdx b/cloud/cloud-overview.mdx index 62a6e8cf3e..bce5d7d522 100644 --- a/cloud/cloud-overview.mdx +++ b/cloud/cloud-overview.mdx @@ -37,7 +37,7 @@ like adding or removing nodes, and run recurring tasks like backing up your data * [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) + * [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) diff --git a/cloud/cloud-security.mdx b/cloud/cloud-security.mdx index 42be3480bc..9e540428e9 100644 --- a/cloud/cloud-security.mdx +++ b/cloud/cloud-security.mdx @@ -101,7 +101,7 @@ We recommend that you generate and use **different certificates** for your clien -If your instance runs on a [burstable CPU](../cloud/cloud-overview.mdx#burstable-vs.-reserved-clusters), especially if it is a low-end one, +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 process. We therefore recommend that you generate your certificates off-cloud and import them to your cloud instance. diff --git a/cloud/portal/cloud-portal-products-tab.mdx b/cloud/portal/cloud-portal-products-tab.mdx index e665e8f71c..a7248c0bcf 100644 --- a/cloud/portal/cloud-portal-products-tab.mdx +++ b/cloud/portal/cloud-portal-products-tab.mdx @@ -42,10 +42,10 @@ 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. [Billing](../../cloud/portal/cloud-portal-products-tab.mdx#b.-new-product-billing) -C. [Customize](../../cloud/portal/cloud-portal-products-tab.mdx#c.-new-product-customize) -D. [Summary](../../cloud/portal/cloud-portal-products-tab.mdx#d.-new-product-summary) +A. [Plan](../../cloud/portal/cloud-portal-products-tab.mdx#a-new-product-plan) +B. [Billing](../../cloud/portal/cloud-portal-products-tab.mdx#b-new-product-billing) +C. [Customize](../../cloud/portal/cloud-portal-products-tab.mdx#c-new-product-customize) +D. [Summary](../../cloud/portal/cloud-portal-products-tab.mdx#d-new-product-summary) #### A. New Product: Plan Use the Plan page to choose your product's cloud **Provider**, **Region** and **Tier**. diff --git a/docs/ai-integration/connection-strings/azure-open-ai.mdx b/docs/ai-integration/connection-strings/azure-open-ai.mdx index 2a2fa4cc4d..628745c087 100644 --- a/docs/ai-integration/connection-strings/azure-open-ai.mdx +++ b/docs/ai-integration/connection-strings/azure-open-ai.mdx @@ -65,7 +65,7 @@ export const supportedLanguages = ["csharp"]; * When making vector search queries, the content of the search terms must also be converted to embeddings to compare them against the stored vectors. Requests to generate such query embeddings via the AI provider are sent in batches. * This parameter defines the maximum number of these batches that can be processed concurrently. - You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#ai.embeddings.maxconcurrentbatches) configuration key. + You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#aiembeddingsmaxconcurrentbatches) configuration key. 10. Click **Test Connection** to confirm the connection string is set up correctly. diff --git a/docs/ai-integration/connection-strings/embedded.mdx b/docs/ai-integration/connection-strings/embedded.mdx index 8b3f86c675..b960fd455a 100644 --- a/docs/ai-integration/connection-strings/embedded.mdx +++ b/docs/ai-integration/connection-strings/embedded.mdx @@ -51,7 +51,7 @@ export const supportedLanguages = ["csharp"]; * When making vector search queries, the content of the search terms must also be converted to embeddings to compare them against the stored vectors. Requests to generate such query embeddings via the AI provider are sent in batches. * This parameter defines the maximum number of these batches that can be processed concurrently. - You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#ai.embeddings.maxconcurrentbatches) configuration key. + You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#aiembeddingsmaxconcurrentbatches) configuration key. 5. Click **Save** to store the connection string or **Cancel** to discard changes. diff --git a/docs/ai-integration/connection-strings/google-ai.mdx b/docs/ai-integration/connection-strings/google-ai.mdx index b747fc1d86..b733664544 100644 --- a/docs/ai-integration/connection-strings/google-ai.mdx +++ b/docs/ai-integration/connection-strings/google-ai.mdx @@ -64,7 +64,7 @@ export const supportedLanguages = ["csharp"]; * When making vector search queries, the content of the search terms must also be converted to embeddings to compare them against the stored vectors. Requests to generate such query embeddings via the AI provider are sent in batches. * This parameter defines the maximum number of these batches that can be processed concurrently. - You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#ai.embeddings.maxconcurrentbatches) configuration key. + You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#aiembeddingsmaxconcurrentbatches) configuration key. 9. Click **Test Connection** to confirm the connection string is set up correctly. diff --git a/docs/ai-integration/connection-strings/hugging-face.mdx b/docs/ai-integration/connection-strings/hugging-face.mdx index 43dac1dd0a..f7ff6e06e9 100644 --- a/docs/ai-integration/connection-strings/hugging-face.mdx +++ b/docs/ai-integration/connection-strings/hugging-face.mdx @@ -58,7 +58,7 @@ export const supportedLanguages = ["csharp"]; * When making vector search queries, the content of the search terms must also be converted to embeddings to compare them against the stored vectors. Requests to generate such query embeddings via the AI provider are sent in batches. * This parameter defines the maximum number of these batches that can be processed concurrently. - You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#ai.embeddings.maxconcurrentbatches) configuration key. + You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#aiembeddingsmaxconcurrentbatches) configuration key. 8. Click **Test Connection** to confirm the connection string is set up correctly. diff --git a/docs/ai-integration/connection-strings/mistral-ai.mdx b/docs/ai-integration/connection-strings/mistral-ai.mdx index 203e06b092..632350c706 100644 --- a/docs/ai-integration/connection-strings/mistral-ai.mdx +++ b/docs/ai-integration/connection-strings/mistral-ai.mdx @@ -56,7 +56,7 @@ export const supportedLanguages = ["csharp"]; * When making vector search queries, the content of the search terms must also be converted to embeddings to compare them against the stored vectors. Requests to generate such query embeddings via the AI provider are sent in batches. * This parameter defines the maximum number of these batches that can be processed concurrently. - You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#ai.embeddings.maxconcurrentbatches) configuration key. + You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#aiembeddingsmaxconcurrentbatches) configuration key. 8. Click **Test Connection** to confirm the connection string is set up correctly. diff --git a/docs/ai-integration/connection-strings/ollama.mdx b/docs/ai-integration/connection-strings/ollama.mdx index 65fe5d1e82..f7b644b1b7 100644 --- a/docs/ai-integration/connection-strings/ollama.mdx +++ b/docs/ai-integration/connection-strings/ollama.mdx @@ -53,7 +53,7 @@ export const supportedLanguages = ["csharp"]; * When making vector search queries, the content of the search terms must also be converted to embeddings to compare them against the stored vectors. Requests to generate such query embeddings via the AI provider are sent in batches. * This parameter defines the maximum number of these batches that can be processed concurrently. - You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#ai.embeddings.maxconcurrentbatches) configuration key. + You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#aiembeddingsmaxconcurrentbatches) configuration key. 7. Click **Test Connection** to confirm the connection string is set up correctly. diff --git a/docs/ai-integration/connection-strings/open-ai.mdx b/docs/ai-integration/connection-strings/open-ai.mdx index 1464807a7c..0bff5bc0d8 100644 --- a/docs/ai-integration/connection-strings/open-ai.mdx +++ b/docs/ai-integration/connection-strings/open-ai.mdx @@ -79,7 +79,7 @@ export const supportedLanguages = ["csharp"]; * When making vector search queries, the content of the search terms must also be converted to embeddings to compare them against the stored vectors. Requests to generate such query embeddings via the AI provider are sent in batches. * This parameter defines the maximum number of these batches that can be processed concurrently. - You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#ai.embeddings.maxconcurrentbatches) configuration key. + You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#aiembeddingsmaxconcurrentbatches) configuration key. 11. Click **Test Connection** to confirm the connection string is set up correctly. diff --git a/docs/ai-integration/generating-embeddings/overview.mdx b/docs/ai-integration/generating-embeddings/overview.mdx index 6e982f3cb8..db52d9517d 100644 --- a/docs/ai-integration/generating-embeddings/overview.mdx +++ b/docs/ai-integration/generating-embeddings/overview.mdx @@ -71,9 +71,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Embeddings generation tasks are [Ongoing Tasks](../../studio/database/tasks/ongoing-tasks/general-info.mdx) that process documents as they change. Before contacting the provider after a document change, the task first checks the cache to see if a matching embedding already exists, avoiding unnecessary requests. * The requests to generate embeddings from the source text are sent to the provider in batches. - The batch size is configurable, see the [Ai.Embeddings.MaxBatchSize](../../server/configuration/ai-integration-configuration.mdx#ai.embeddings.maxbatchsize) configuration key. + The batch size is configurable, see the [Ai.Embeddings.MaxBatchSize](../../server/configuration/ai-integration-configuration.mdx#aiembeddingsmaxbatchsize) configuration key. * A failed embeddings generation task will retry after the duration set in the - [Ai.Embeddings.MaxFallbackTimeInSec](../../server/configuration/ai-integration-configuration.mdx#ai.embeddings.maxfallbacktimeinsec) configuration key. + [Ai.Embeddings.MaxFallbackTimeInSec](../../server/configuration/ai-integration-configuration.mdx#aiembeddingsmaxfallbacktimeinsec) configuration key. @@ -126,8 +126,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * The number of embeddings generation tasks across all databases can also be monitored using [SNMP](../../server/administration/snmp/snmp-overview.mdx). The following SNMP OIDs provide relevant metrics: - * [5.1.11.25](../../server/administration/snmp/snmp-overview.mdx#5.1.11.25) – Total number of enabled embeddings generation tasks. - * [5.1.11.26](../../server/administration/snmp/snmp-overview.mdx#5.1.11.26) – Total number of active embeddings generation tasks. + * [5.1.11.25](../../server/administration/snmp/snmp-overview.mdx#511125) – Total number of enabled embeddings generation tasks. + * [5.1.11.26](../../server/administration/snmp/snmp-overview.mdx#511126) – Total number of active embeddings generation tasks. diff --git a/docs/ai-integration/vector-search/vector-search-using-dynamic-query.mdx b/docs/ai-integration/vector-search/vector-search-using-dynamic-query.mdx index 1b59f8275e..c17dfd9dbd 100644 --- a/docs/ai-integration/vector-search/vector-search-using-dynamic-query.mdx +++ b/docs/ai-integration/vector-search/vector-search-using-dynamic-query.mdx @@ -123,7 +123,7 @@ export const supportedLanguages = ["csharp"]; * **Search results**: By default, the resulting documents will be ordered by their score. - You can modify this behavior using the [Indexing.Corax.VectorSearch.OrderByScoreAutomatically](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.orderbyscoreautomatically) configuration key. + You can modify this behavior using the [Indexing.Corax.VectorSearch.OrderByScoreAutomatically](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchorderbyscoreautomatically) configuration key. In addition, you can apply any of the 'order by' methods to your query, as explained in [sort query results](../../client-api/session/querying/sort-query-results.mdx). @@ -147,7 +147,7 @@ export const supportedLanguages = ["csharp"]; it is recommended to explicitly specify the minimum similarity level at query time. If not specified, the default value is taken from the following configuration key: - [Indexing.Corax.VectorSearch.DefaultMinimumSimilarity](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultminimumsimilarity). + [Indexing.Corax.VectorSearch.DefaultMinimumSimilarity](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultminimumsimilarity). * **Number of candidates** You can specify the maximum number of vectors that RavenDB will return from a graph search. @@ -156,7 +156,7 @@ export const supportedLanguages = ["csharp"]; * higher than the number of candidates - when the same vector is shared between multiple documents. If not specified, the default value is taken from the following configuration key: - [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultnumberofcandidatesforquerying). + [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofcandidatesforquerying). * **Search method** * _Approximate Nearest-Neighbor search_ (Default): @@ -172,7 +172,7 @@ export const supportedLanguages = ["csharp"]; #### Corax auto-indexes * Only [Corax indexes](../../indexes/search-engine/corax.mdx) support vector search. -* Even if your **default auto-index engine** is set to Lucene (via [Indexing.Auto.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexing.auto.searchenginetype)), +* Even if your **default auto-index engine** is set to Lucene (via [Indexing.Auto.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexingautosearchenginetype)), performing a vector search using a dynamic query will create a new auto-index based on Corax. * Normally, new dynamic queries extend existing [auto-indexes](../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index) if they require additional fields. @@ -1501,8 +1501,8 @@ and (vector.search(embedding.text(Name), $searchTerm, 0.75, 25)) * You can combine multiple vector search statements in the same query using logical operators. This is useful when you want to retrieve documents that match more than one vector-based criterion. -* This can be done using [DocumentQuery](../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery), - [RawQuery](../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) or raw [RQL](../../client-api/session/querying/what-is-rql.mdx). +* This can be done using [DocumentQuery](../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery), + [RawQuery](../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) or raw [RQL](../../client-api/session/querying/what-is-rql.mdx). * In the example below, the results will include companies that match one of two vector search conditions: * Companies from European countries with a _Name_ similar to "snack" @@ -1653,7 +1653,7 @@ or * 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). - * If not specified, it is taken from the [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultnumberofcandidatesforquerying) configuration key (default is 16). + * 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. @@ -1707,10 +1707,10 @@ public IRavenQueryable VectorSearch( The default value for `minimumSimilarity` is defined by this configuration key: -[Indexing.Corax.VectorSearch.DefaultMinimumSimilarity ](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultnumberofcandidatesforquerying). +[Indexing.Corax.VectorSearch.DefaultMinimumSimilarity ](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofcandidatesforquerying). The default value for `numberOfCandidates` is defined by this configuration key: -[Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultminimumsimilarity). +[Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultminimumsimilarity). `IVectorFieldFactory`: diff --git a/docs/ai-integration/vector-search/vector-search-using-static-index.mdx b/docs/ai-integration/vector-search/vector-search-using-static-index.mdx index 19f445692a..bb264e03d4 100644 --- a/docs/ai-integration/vector-search/vector-search-using-static-index.mdx +++ b/docs/ai-integration/vector-search/vector-search-using-static-index.mdx @@ -92,11 +92,11 @@ For numerical input only - define the size of the array from your source documen **Number of edges** - Specify the number of edges that will be created for a vector during indexing. -If not specified, the default value is taken from the following configuration key: [Indexing.Corax.VectorSearch.DefaultNumberOfEdges](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultnumberofedges). +If not specified, the default value is taken from the following configuration key: [Indexing.Corax.VectorSearch.DefaultNumberOfEdges](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofedges). **Number of candidates for indexing time** - The number of candidates (potential neighboring vectors) that RavenDB evaluates during vector indexing. -If not specified, the default value is taken from the following configuration key: [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForIndexing](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultnumberofcandidatesforindexing). +If not specified, the default value is taken from the following configuration key: [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForIndexing](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofcandidatesforindexing). (Note, this param differs from the number of candidates for query time). @@ -127,7 +127,7 @@ enabling efficient retrieval of Approximate Nearest Neighbors (ANN) during queri **Minimum similarity** - You can specify the minimum similarity to use when searching for related vectors. Can be a value between `0.0f` and `1.0f`. A value closer to `1.0f` requires higher similarity between vectors, while a value closer to `0.0f` allows for less similarity. -If not specified, the default value is taken from the following configuration key: [Indexing.Corax.VectorSearch.DefaultMinimumSimilarity](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultminimumsimilarity). +If not specified, the default value is taken from the following configuration key: [Indexing.Corax.VectorSearch.DefaultMinimumSimilarity](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultminimumsimilarity). **Number of candidates at query time** - You can specify the maximum number of vectors that RavenDB will return from a graph search. @@ -137,7 +137,7 @@ The number of the resulting documents that correspond to these vectors may be: * higher than the number of candidates - when the same vector is shared between multiple documents. -If not specified, the default value is taken from the following configuration key: [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultnumberofcandidatesforquerying). +If not specified, the default value is taken from the following configuration key: [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofcandidatesforquerying). **Search method** - You can specify the search method at query time: @@ -156,7 +156,7 @@ The server will search for the most similar vectors in the indexed vector space, The documents that correspond to the resulting vectors are then returned to the client. By default, the resulting documents will be ordered by their score. -You can modify this behavior using the [Indexing.Corax.VectorSearch.OrderByScoreAutomatically](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.orderbyscoreautomatically) configuration key. +You can modify this behavior using the [Indexing.Corax.VectorSearch.OrderByScoreAutomatically](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchorderbyscoreautomatically) configuration key. In addition, you can apply any of the 'order by' methods to your query, as explained in [sort query results](../../client-api/session/querying/sort-query-results.mdx). 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 61568007ae..e0a03e06cf 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 @@ -94,7 +94,7 @@ They help keep memory usage and indexing time under control, but may also limit * With **static-indexes** - This param can be set directly in the index definition. For example, see this [index definition](../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-raw-text). If not explicitly set, or when using **dynamic queries** - - the value is taken from the [Indexing.Corax.VectorSearch.DefaultNumberOfEdges](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultnumberofedges) configuration key. + the value is taken from the [Indexing.Corax.VectorSearch.DefaultNumberOfEdges](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofedges) configuration key. * **Number of candidates at indexing time**: @@ -109,7 +109,7 @@ They help keep memory usage and indexing time under control, but may also limit * With **static-indexes** - This param can be set directly in the index definition. For example, see this [index definition](../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-raw-text). If not explicitly set, or when using **dynamic queries** - - the value is taken from the [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForIndexing](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultnumberofcandidatesforindexing) configuration key. + the value is taken from the [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForIndexing](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofcandidatesforindexing) configuration key. For all parameters that can be defined at indexing time (including the ones above), see [Parameters defined at index definition](../../ai-integration/vector-search/vector-search-using-static-index.mdx#parameters-defined-at-index-definition). @@ -129,7 +129,7 @@ These parameters directly affect how many results are found, how similar they ar and typically improving accuracy and the chances of retrieving all relevant results - but this comes at the cost of slower query performance. A **smaller** value speeds up queries and reduces resource usage, but increases the chance of missing relevant results due to the more limited exploration. * This param can be set directly in the query. For example, see this [Query example](../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-raw-text). - If not explicitly set, the value is taken from the [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultnumberofcandidatesforquerying) configuration key. + If not explicitly set, the value is taken from the [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofcandidatesforquerying) configuration key. * **Minimum Similarity**: @@ -138,7 +138,7 @@ These parameters directly affect how many results are found, how similar they ar even if they would otherwise be among the top candidates. Use this to filter out marginal matches, especially when minimum semantic relevance is important. * This param can be set directly in the query. For example, see this [Query example](../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-raw-text). - If not explicitly set in the query, the value is taken from the [Indexing.Corax.VectorSearch.DefaultMinimumSimilarity](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultminimumsimilarity) configuration key. + If not explicitly set in the query, the value is taken from the [Indexing.Corax.VectorSearch.DefaultMinimumSimilarity](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultminimumsimilarity) configuration key. The default value of this configuration key is `0.0`, which means no similarity filtering is applied - all candidates found during the search are eligible to be returned, regardless of how dissimilar they are from the query vector. diff --git a/docs/client-api/changes/what-is-changes-api.mdx b/docs/client-api/changes/what-is-changes-api.mdx index 8e9a9aa5df..588f87a629 100644 --- a/docs/client-api/changes/what-is-changes-api.mdx +++ b/docs/client-api/changes/what-is-changes-api.mdx @@ -183,7 +183,7 @@ finally #### Changes API and Database Timeout One or more open Changes API connections will prevent a database from becoming -idle and unloaded, regardless of [the configuration value for database idle timeout](../../server/configuration/database-configuration.mdx#databases.maxidletimeinsec). +idle and unloaded, regardless of [the configuration value for database idle timeout](../../server/configuration/database-configuration.mdx#databasesmaxidletimeinsec). #### Changes API and Method Overloads @@ -343,7 +343,7 @@ try \{ One or more open Changes API connections will prevent a database from becoming -idle and unloaded, regardless of [the configuration value for database idle timeout](../../server/configuration/database-configuration.mdx#databases.maxidletimeinsec). +idle and unloaded, regardless of [the configuration value for database idle timeout](../../server/configuration/database-configuration.mdx#databasesmaxidletimeinsec). @@ -492,7 +492,7 @@ try \{ #### Changes API and Database Timeout One or more open Changes API connections will prevent a database from becoming -idle and unloaded, regardless of [the configuration value for database idle timeout](../../server/configuration/database-configuration.mdx#databases.maxidletimeinsec). +idle and unloaded, regardless of [the configuration value for database idle timeout](../../server/configuration/database-configuration.mdx#databasesmaxidletimeinsec). #### Changes API and Method Overloads diff --git a/docs/client-api/configuration/conventions.mdx b/docs/client-api/configuration/conventions.mdx index 57da35a0d3..6b96429f83 100644 --- a/docs/client-api/configuration/conventions.mdx +++ b/docs/client-api/configuration/conventions.mdx @@ -28,8 +28,8 @@ export const supportedLanguages = ["csharp", "nodejs"]; * [How to set conventions](../../client-api/configuration/conventions.mdx#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#aggressivecache.duration) - [AggressiveCache.Mode](../../client-api/configuration/conventions.mdx#aggressivecache.mode) + [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) diff --git a/docs/client-api/configuration/serialization.mdx b/docs/client-api/configuration/serialization.mdx index 08ae36a0ae..9e723ea7a3 100644 --- a/docs/client-api/configuration/serialization.mdx +++ b/docs/client-api/configuration/serialization.mdx @@ -27,7 +27,7 @@ by which entities are serialized as they are sent by the client to the server. * In this page: * [CustomizeJsonSerializer](../../client-api/configuration/serialization.mdx#customizejsonserializer) * [JsonContractResolver](../../client-api/configuration/serialization.mdx#jsoncontractresolver) - * [BulkInsert.TrySerializeEntityToJsonStream](../../client-api/configuration/serialization.mdx#bulkinsert.tryserializeentitytojsonstream) + * [BulkInsert.TrySerializeEntityToJsonStream](../../client-api/configuration/serialization.mdx#bulkinserttryserializeentitytojsonstream) * [IgnoreByRefMembers and IgnoreUnsafeMembers](../../client-api/configuration/serialization.mdx#ignorebyrefmembers-and-ignoreunsafemembers) diff --git a/docs/client-api/data-subscriptions/consumption/api-overview.mdx b/docs/client-api/data-subscriptions/consumption/api-overview.mdx index 9e6dc1290f..276946a9b6 100644 --- a/docs/client-api/data-subscriptions/consumption/api-overview.mdx +++ b/docs/client-api/data-subscriptions/consumption/api-overview.mdx @@ -26,7 +26,7 @@ export const supportedLanguages = ["csharp", "java", "python", "nodejs"]; * [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>) - * [SubscriptionBatch<T>.Item](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatch<t>.item) + * [SubscriptionBatch<T>.Item](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatch<t>item) * [SubscriptionWorker<T>](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworker<t>) @@ -160,7 +160,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#subscriptionbatch<t>.item) below. | +| **Items** | `List.Item>` | List of items in the batch.
See [SubscriptionBatch<T>.Item](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatch<t>item) below. | | **NumberOfItemsInBatch** | `int` | Number of items in the batch. | | Method Signature | Return value | Description | diff --git a/docs/client-api/faq/backward-compatibility.mdx b/docs/client-api/faq/backward-compatibility.mdx index 617ccc77b4..a9f841bd0d 100644 --- a/docs/client-api/faq/backward-compatibility.mdx +++ b/docs/client-api/faq/backward-compatibility.mdx @@ -23,11 +23,11 @@ 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-4.1) - * [Compatibility - RavenDB 4.2 and Higher](../../client-api/faq/backward-compatibility.mdx#compatibility---ravendb-4.2-and-higher) + * [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-4.1) - * [Upgrading - RavenDB 4.2 and Higher](../../client-api/faq/backward-compatibility.mdx#upgrading---ravendb-4.2-and-higher) + * [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) @@ -81,7 +81,7 @@ page to learn more about migrating from early versions. ### 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#ravendb-4.2-and-higher-compatibility). +are [compatible with servers of versions higher than theirs](../../client-api/faq/backward-compatibility.mdx#ravendb-42-and-higher-compatibility). ### Upgrading Order To properly upgrade your applications and server, we advise you to upgrade the server first, then the clients. diff --git a/docs/client-api/operations/common/delete-by-query.mdx b/docs/client-api/operations/common/delete-by-query.mdx index a8e114889d..d33d92b86a 100644 --- a/docs/client-api/operations/common/delete-by-query.mdx +++ b/docs/client-api/operations/common/delete-by-query.mdx @@ -40,7 +40,7 @@ export const supportedLanguages = ["csharp", "java", "python", "php", "nodejs"]; * To avoid issues when recreating such documents using a cluster-wide session, see [Best practice when storing a document](../../../client-api/session/cluster-transaction/atomic-guards.mdx#best-practice-when-storing-a-document-in-a-cluster-wide-transaction). * 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). + 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) @@ -551,7 +551,7 @@ so it can happen than a document has been updated or deleted meanwhile. * To avoid issues when recreating such documents using a cluster-wide session, see [Best practice when storing a document](../../../client-api/session/cluster-transaction/atomic-guards.mdx#best-practice-when-storing-a-document-in-a-cluster-wide-transaction). * 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). + 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) @@ -754,7 +754,7 @@ document_id_that_was_deleted = details[0]["Id"] * To avoid issues when recreating such documents using a cluster-wide session, see [Best practice when storing a document](../../../client-api/session/cluster-transaction/atomic-guards.mdx#best-practice-when-storing-a-document-in-a-cluster-wide-transaction). * 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). + 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) @@ -1046,7 +1046,7 @@ $documentIdThatWasDeleted = $details[0]->getId(); * To avoid issues when recreating such documents using a cluster-wide session, see [Best practice when storing a document](../../../client-api/session/cluster-transaction/atomic-guards.mdx#best-practice-when-storing-a-document-in-a-cluster-wide-transaction). * 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). + 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) diff --git a/docs/client-api/operations/compare-exchange/include-compare-exchange.mdx b/docs/client-api/operations/compare-exchange/include-compare-exchange.mdx index d74440f32a..83cb0d9486 100644 --- a/docs/client-api/operations/compare-exchange/include-compare-exchange.mdx +++ b/docs/client-api/operations/compare-exchange/include-compare-exchange.mdx @@ -596,7 +596,7 @@ select includeCmpXchg(c) * Note: - Similar to the above dynamic query example, you can query the index with a [raw query](../../../indexes/querying/query-index.mdx#session.advanced.rawquery) using the provided RQL. + Similar to the above dynamic query example, you can query the index with a [raw query](../../../indexes/querying/query-index.mdx#sessionadvancedrawquery) using the provided RQL. diff --git a/docs/client-api/operations/compare-exchange/overview.mdx b/docs/client-api/operations/compare-exchange/overview.mdx index f8fadc6c84..f7845eac52 100644 --- a/docs/client-api/operations/compare-exchange/overview.mdx +++ b/docs/client-api/operations/compare-exchange/overview.mdx @@ -79,7 +79,7 @@ Compare exchange items are created and managed with any of the following approac * **Atomic Guards** When creating documents using a cluster-wide session RavenDB automatically creates [Atomic Guards](../../../client-api/session/cluster-transaction/atomic-guards.mdx), which are compare-exchange items that guarantee ACID transactions. - See [Cluster-wide vs. Single-node](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) for a session comparision overview. + See [Cluster-wide vs. Single-node](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) for a session comparision overview. * **Studio** Compare-exchange items can be created from the [Studio](../../../studio/database/documents/compare-exchange-view.mdx#the-compare-exchange-view) as well. @@ -622,7 +622,7 @@ Compare exchange items are created and managed with any of the following approac * **Atomic Guards** When creating documents using a cluster-wide session RavenDB automatically creates [Atomic Guards](../../../client-api/session/cluster-transaction/atomic-guards.mdx), which are compare-exchange items that guarantee ACID transactions. - See [Cluster-wide vs. Single-node](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) for a session comparision overview. + See [Cluster-wide vs. Single-node](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) for a session comparision overview. * **Studio** Compare-exchange items can be created from the [Studio](../../../studio/database/documents/compare-exchange-view.mdx#the-compare-exchange-view) as well. @@ -894,7 +894,7 @@ Compare exchange items are created and managed with any of the following approac * **Atomic Guards** When creating documents using a cluster-wide session RavenDB automatically creates [Atomic Guards](../../../client-api/session/cluster-transaction/atomic-guards.mdx), which are compare-exchange items that guarantee ACID transactions. - See [Cluster-wide vs. Single-node](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) for a session comparision overview. + See [Cluster-wide vs. Single-node](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) for a session comparision overview. * **Studio** Compare-exchange items can be created from the [Studio](../../../studio/database/documents/compare-exchange-view.mdx#the-compare-exchange-view) as well. diff --git a/docs/client-api/operations/how-to/switch-operations-to-a-different-database.mdx b/docs/client-api/operations/how-to/switch-operations-to-a-different-database.mdx index 8c04189169..62443644d7 100644 --- a/docs/client-api/operations/how-to/switch-operations-to-a-different-database.mdx +++ b/docs/client-api/operations/how-to/switch-operations-to-a-different-database.mdx @@ -27,8 +27,8 @@ export const supportedLanguages = ["csharp", "java", "python", "php", "nodejs"]; If the requested database doesn't exist on the server, an exception will be thrown. * In this page: - * [Common operation: `Operations.ForDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#common-operation:-operations.fordatabase) - * [Maintenance operation: `Maintenance.ForDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#maintenance-operation:-maintenance.fordatabase) + * [Common operation: `Operations.ForDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#common-operation:-operationsfordatabase) + * [Maintenance operation: `Maintenance.ForDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#maintenance-operation:-maintenancefordatabase) ## Common operation: `Operations.ForDatabase` @@ -205,8 +205,8 @@ As with `operations`, by default the `maintenance` operations available directly If the requested database doesn't exist on the server, an exception will be thrown. * In this page: - * [Common operation: `operations.for_database`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#common-operation:-operations.for_database) - * [Maintenance operation: `maintenance.for_database`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#maintenance-operation:-maintenance.for_database) + * [Common operation: `operations.for_database`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#common-operation:-operationsfor_database) + * [Maintenance operation: `maintenance.for_database`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#maintenance-operation:-maintenancefor_database) ## Common operation: `operations.for_database` @@ -301,7 +301,7 @@ with DocumentStore() as document_store: * In this page: * [Common operation: `forDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#common-operation:-fordatabase) - * [Maintenance operation: `maintenance.for_database`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#maintenance-operation:-maintenance.for_database) + * [Maintenance operation: `maintenance.for_database`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#maintenance-operation:-maintenancefor_database) ## Common operation: `forDatabase` @@ -411,8 +411,8 @@ try \{ If the requested database doesn't exist on the server, an exception will be thrown. * In this page: - * [Common operation: `operations.forDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#common-operation:-operations.fordatabase) - * [Maintenance operation: `maintenance.forDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#maintenance-operation:-maintenance.fordatabase) + * [Common operation: `operations.forDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#common-operation:-operationsfordatabase) + * [Maintenance operation: `maintenance.forDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#maintenance-operation:-maintenancefordatabase) ## Common operation: `operations.forDatabase` diff --git a/docs/client-api/operations/maintenance/backup/backup-overview.mdx b/docs/client-api/operations/maintenance/backup/backup-overview.mdx index f6c7ab02b1..bfb7112f22 100644 --- a/docs/client-api/operations/maintenance/backup/backup-overview.mdx +++ b/docs/client-api/operations/maintenance/backup/backup-overview.mdx @@ -208,7 +208,7 @@ IncrementalBackupFrequency = "*/20 * * * *", * RavenDB will store data in a local folder first, and transfer it to the remote destination from the local one. * If a local folder hasn't been specified, RavenDB will use the - temp folder defined in its [Storage.TempPath](../../../../server/configuration/storage-configuration.mdx#storage.temppath) setting. + temp folder defined in its [Storage.TempPath](../../../../server/configuration/storage-configuration.mdx#storagetemppath) setting. If _Storage.TempPath_ is not defined, the temporary files will be created at the same location as the data file. In either case, the folder will be used as temporary storage diff --git a/docs/client-api/operations/patching/single-document.mdx b/docs/client-api/operations/patching/single-document.mdx index 8151f447f7..5736133e3b 100644 --- a/docs/client-api/operations/patching/single-document.mdx +++ b/docs/client-api/operations/patching/single-document.mdx @@ -1164,7 +1164,7 @@ The method can be called by document ID or by document reference. * When using a JavaScript script with the _defer_ or _operations_ syntax, you can apply logic using **inline string compilation**. -* To enable this, set the [Patching.AllowStringCompilation](../../../server/configuration/patching-configuration.mdx#patching.allowstringcompilation) configuration key to _true_. +* To enable this, set the [Patching.AllowStringCompilation](../../../server/configuration/patching-configuration.mdx#patchingallowstringcompilation) configuration key to _true_. @@ -3292,7 +3292,7 @@ await documentStore.operations.send(patchOp); #### Patching using inline string compilation * When using a JavaScript script with the _defer_ or _operations_ syntax, you can apply logic using **inline string compilation**. -* To enable this, set the [Patching.AllowStringCompilation](../../../server/configuration/patching-configuration.mdx#patching.allowstringcompilation) configuration key to _true_. +* To enable this, set the [Patching.AllowStringCompilation](../../../server/configuration/patching-configuration.mdx#patchingallowstringcompilation) configuration key to _true_. diff --git a/docs/client-api/session/cluster-transaction/atomic-guards.mdx b/docs/client-api/session/cluster-transaction/atomic-guards.mdx index a7114527d0..c98e0d24ab 100644 --- a/docs/client-api/session/cluster-transaction/atomic-guards.mdx +++ b/docs/client-api/session/cluster-transaction/atomic-guards.mdx @@ -269,7 +269,7 @@ Atomic guards are removed **automatically** in the following scenarios: even if the document is expected to be new. * This is especially important if a document (originally created in a cluster-wide transaction) was deleted **outside** of a cluster-wide session - - as when using a [single-node session](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) + as when using a [single-node session](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) or the [DeleteByQueryOperation](../../../client-api/operations/common/delete-by-query.mdx). In these cases, the document is deleted, but the atomic guard remains (it is not automatically removed). If you attempt to re-create such a document without loading it first, @@ -563,7 +563,7 @@ Atomic guards are removed **automatically** in the following scenarios: even if the document is expected to be a new document. * This is especially important if a document (originally created in a cluster-wide transaction) was deleted **outside** of a cluster-wide session - - e.g., when using a [single-node session](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) + e.g., when using a [single-node session](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) or the [DeleteByQueryOperation](../../../client-api/operations/common/delete-by-query.mdx). In these cases, the document is deleted, but the atomic guard remains (it is not automatically removed). If you attempt to re-create such a document without loading it first, @@ -833,7 +833,7 @@ Atomic guards are removed **automatically** in the following scenarios: even if the document is expected to be a new document. * This is especially important if a document (originally created in a cluster-wide transaction) was deleted **outside** of a cluster-wide session - - e.g., when using a [single-node session](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) + e.g., when using a [single-node session](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) or the [DeleteByQueryOperation](../../../client-api/operations/common/delete-by-query.mdx). In these cases, the document is deleted, but the atomic guard remains (it is not automatically removed). If you attempt to re-create such a document without loading it first, @@ -1094,7 +1094,7 @@ Atomic guards are removed **automatically** in the following scenarios: even if the document is expected to be a new document. * This is especially important if a document (originally created in a cluster-wide transaction) was deleted **outside** of a cluster-wide session - - e.g., when using a [single-node session](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) + e.g., when using a [single-node session](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) or the [DeleteByQueryOperation](../../../client-api/operations/common/delete-by-query.mdx). In these cases, the document is deleted, but the atomic guard remains (it is not automatically removed). If you attempt to re-create such a document without loading it first, diff --git a/docs/client-api/session/cluster-transaction/overview.mdx b/docs/client-api/session/cluster-transaction/overview.mdx index 58e6bfbfa2..6b0863a4ef 100644 --- a/docs/client-api/session/cluster-transaction/overview.mdx +++ b/docs/client-api/session/cluster-transaction/overview.mdx @@ -30,7 +30,7 @@ export const supportedLanguages = ["csharp", "python", "php", "nodejs"]; * 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) + * [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 @@ -145,7 +145,7 @@ For a detailed description of transactions in RavenDB please refer to the [Trans * 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) + * [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 @@ -242,7 +242,7 @@ For a detailed description of transactions in RavenDB please refer to the [Trans * 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) + * [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 @@ -347,7 +347,7 @@ For a detailed description of transactions in RavenDB please refer to the [Trans * 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) + * [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 diff --git a/docs/client-api/session/opening-a-session.mdx b/docs/client-api/session/opening-a-session.mdx index 01fd1613e5..0e2dda3ffa 100644 --- a/docs/client-api/session/opening-a-session.mdx +++ b/docs/client-api/session/opening-a-session.mdx @@ -92,7 +92,7 @@ IAsyncDocumentSession OpenAsyncSession(SessionOptions options); | **NoTracking** | `bool` | `true` - The Session tracks changes made to all entities it loaded, stored, or queried for.
`false` - Tracking will be turned off.
Learn more in [Disable tracking](../../client-api/session/configuration/how-to-disable-tracking.mdx) | `false` | | **NoCaching** | `bool` | `true` - Server responses will Not be cached.
`false` - The Session caches the server responses.
Learn more in [Disable caching](../../client-api/session/configuration/how-to-disable-caching.mdx) | `false` | | **RequestExecutor** | `RequestExecutor` | ( _Advanced option_ )
The request executor the Session should use. | `null` - the default request executor is used | -| **TransactionMode** | `TransactionMode` | Specify the Session's transaction mode
`SingleNode` / `ClusterWide`
Learn more in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) | `SingleNode` | +| **TransactionMode** | `TransactionMode` | Specify the Session's transaction mode
`SingleNode` / `ClusterWide`
Learn more in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) | `SingleNode` | * Experts Only: @@ -341,7 +341,7 @@ def open_session( | **no_tracking** | `bool` | `True` - The Session tracks changes made to all entities it loaded, stored, or queried for.
`False` - Tracking will be turned off.
Learn more in [Disable tracking](../../client-api/session/configuration/how-to-disable-tracking.mdx) | `False` | | **no_caching** | `bool` | `True` - Server responses will not be cached.
`False` - The Session caches the server responses.
Learn more in [Disable caching](../../client-api/session/configuration/how-to-disable-caching.mdx) | `False` | | **request_executor** | `RequestExecutor` | ( _Advanced option_ )
The request executor the Session should use. | `None` - the default request executor is used | -| **transaction_mode** | `TransactionMode` | Specify the Session's transaction mode
`SINGLE_NODE` / `CLUSTER_WIDE`
Learn more in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) | `SINGLE_NODE` | +| **transaction_mode** | `TransactionMode` | Specify the Session's transaction mode
`SINGLE_NODE` / `CLUSTER_WIDE`
Learn more in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) | `SINGLE_NODE` | * Experts Only: @@ -432,7 +432,7 @@ public function openSession(SessionOptions $sessionOptions): DocumentSessionInte | **NoTracking** | `bool` | `true` - The Session tracks changes made to all entities it loaded, stored, or queried for.
`false` - Tracking will be turned off.
Learn more in [Disable tracking](../../client-api/session/configuration/how-to-disable-tracking.mdx) | `false` | | **NoCaching** | `bool` | `true` - Server responses will Not be cached.
`false` - The Session caches the server responses.
Learn more in [Disable caching](../../client-api/session/configuration/how-to-disable-caching.mdx) | `false` | | **RequestExecutor** | `RequestExecutor` | ( _Advanced option_ )
The request executor the Session should use. | `null` - the default request executor is used | -| **TransactionMode** | `TransactionMode` | Specify the Session's transaction mode
`SingleNode` / `ClusterWide`
Learn more in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) | `SingleNode` | +| **TransactionMode** | `TransactionMode` | Specify the Session's transaction mode
`SingleNode` / `ClusterWide`
Learn more in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) | `SingleNode` | * Experts Only: @@ -573,7 +573,7 @@ openSession(sessionOptions); | **noTracking** | boolean | `true` - The session tracks changes made to all entities it loaded, stored, or queried for.
`false` - Tracking will be turned off.
Learn more in [Disable tracking](../../client-api/session/configuration/how-to-disable-tracking.mdx) | `false` | | **noCaching** | boolean | `true` - Server responses will Not be cached.
`false` - The session caches the server responses.
Learn more in [Disable caching](../../client-api/session/configuration/how-to-disable-caching.mdx) | `false` | | **requestExecutor** | `RequestExecutor` | ( _Advanced option_ )
The request executor the session should use. | `null` - the default request executor is used | -| **transactionMode** | `TransactionMode` | Specify the session's transaction mode
`SingleNode` / `ClusterWide`
Learn more in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) | `SingleNode` | +| **transactionMode** | `TransactionMode` | Specify the session's transaction mode
`SingleNode` / `ClusterWide`
Learn more in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) | `SingleNode` | * Experts Only: diff --git a/docs/client-api/session/querying/document-query/what-is-document-query.mdx b/docs/client-api/session/querying/document-query/what-is-document-query.mdx index ff61427c33..cb62f130fb 100644 --- a/docs/client-api/session/querying/document-query/what-is-document-query.mdx +++ b/docs/client-api/session/querying/document-query/what-is-document-query.mdx @@ -159,7 +159,7 @@ List products = await asyncSession.Advanced #### Query an index -Please refer to [Querying an index](../../../../indexes/querying/query-index.mdx#session.advanced.documentquery) for examples of querying an index using a DocumentQuery. +Please refer to [Querying an index](../../../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) for examples of querying an index using a DocumentQuery. @@ -674,7 +674,7 @@ products = list(session.advanced.document_query(object_type=Product).skip(5).tak #### Query an index -Please refer to [Querying an index](../../../../indexes/querying/query-index.mdx#session.advanced.documentquery) for examples of querying an index using document_query. +Please refer to [Querying an index](../../../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) for examples of querying an index using document_query. @@ -880,7 +880,7 @@ $employees = $session -Please refer to [Querying an index](../../../../indexes/querying/query-index.mdx#session.advanced.documentquery) for examples of querying an index using a documentQuery. +Please refer to [Querying an index](../../../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) for examples of querying an index using a documentQuery. diff --git a/docs/client-api/session/querying/how-to-make-a-spatial-query.mdx b/docs/client-api/session/querying/how-to-make-a-spatial-query.mdx index 6467cf586e..fe91b698f8 100644 --- a/docs/client-api/session/querying/how-to-make-a-spatial-query.mdx +++ b/docs/client-api/session/querying/how-to-make-a-spatial-query.mdx @@ -691,7 +691,7 @@ order by spatial.distance( This metadata property is always available in the results. * When using **Corax**: In order to enhance performance, this property is not included in the results by default. - To get this metadata property you must set the [Indexing.Corax.IncludeSpatialDistance](../../../server/configuration/indexing-configuration.mdx#indexing.corax.includespatialdistance) configuration value to _true_. + To get this metadata property you must set the [Indexing.Corax.IncludeSpatialDistance](../../../server/configuration/indexing-configuration.mdx#indexingcoraxincludespatialdistance) configuration value to _true_. Learn about the available methods for setting an indexing configuration key in this [indexing-configuration](../../../server/configuration/indexing-configuration.mdx) article. @@ -1609,7 +1609,7 @@ order by spatial.distance( This metadata property is always available in the results. * When using **Corax**: In order to enhance performance, this property is not included in the results by default. - To get this metadata property you must set the [Indexing.Corax.IncludeSpatialDistance](../../../server/configuration/indexing-configuration.mdx#indexing.corax.includespatialdistance) configuration value to _true_. + To get this metadata property you must set the [Indexing.Corax.IncludeSpatialDistance](../../../server/configuration/indexing-configuration.mdx#indexingcoraxincludespatialdistance) configuration value to _true_. Learn about the available methods for setting an indexing configuration key in this [indexing-configuration](../../../server/configuration/indexing-configuration.mdx) article. @@ -2152,7 +2152,7 @@ order by spatial.distance( * When using __Corax__: In order to enhance performance, this property is not included in the results by default. - To get this metadata property you must set the [Indexing.Corax.IncludeSpatialDistance](../../../server/configuration/indexing-configuration.mdx#indexing.corax.includespatialdistance) configuration value to _true_. + To get this metadata property you must set the [Indexing.Corax.IncludeSpatialDistance](../../../server/configuration/indexing-configuration.mdx#indexingcoraxincludespatialdistance) configuration value to _true_. Learn about the available methods for setting an indexing configuration key in this [indexing-configuration](../../../server/configuration/indexing-configuration.mdx) article. diff --git a/docs/client-api/session/querying/how-to-project-query-results.mdx b/docs/client-api/session/querying/how-to-project-query-results.mdx index ddf95312e8..be0353d123 100644 --- a/docs/client-api/session/querying/how-to-project-query-results.mdx +++ b/docs/client-api/session/querying/how-to-project-query-results.mdx @@ -92,8 +92,8 @@ export const supportedLanguages = ["csharp", "java", "python", "php", "nodejs"]; * But while calculations within a projection are allowed, having a very complex logic can impact query performance. So RavenDB limits the total time it will spend processing a query and its projections. Exceeding this time limit will fail the query. This is configurable, see the following configuration keys: - * [Databases.QueryTimeoutInSec](../../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec) - * [Databases.QueryOperationTimeoutInSec](../../../server/configuration/database-configuration.mdx#databases.queryoperationtimeoutinsec) + * [Databases.QueryTimeoutInSec](../../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec) + * [Databases.QueryOperationTimeoutInSec](../../../server/configuration/database-configuration.mdx#databasesqueryoperationtimeoutinsec) @@ -1240,8 +1240,8 @@ If the projected fields are stored inside the index itself (`FieldStorage.YES` i * But while calculations within a projection are allowed, having a very complex logic can impact query performance. So RavenDB limits the total time it will spend processing a query and its projections. Exceeding this time limit will fail the query. This is configurable, see the following configuration keys: - * [Databases.QueryTimeoutInSec](../../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec) - * [Databases.QueryOperationTimeoutInSec](../../../server/configuration/database-configuration.mdx#databases.queryoperationtimeoutinsec) + * [Databases.QueryTimeoutInSec](../../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec) + * [Databases.QueryOperationTimeoutInSec](../../../server/configuration/database-configuration.mdx#databasesqueryoperationtimeoutinsec) @@ -1652,8 +1652,8 @@ except Exception as e: * But while calculations within a projection are allowed, having a very complex logic can impact query performance. So RavenDB limits the total time it will spend processing a query and its projections. Exceeding this time limit will fail the query. This is configurable, see the following configuration keys: - * [Databases.QueryTimeoutInSec](../../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec) - * [Databases.QueryOperationTimeoutInSec](../../../server/configuration/database-configuration.mdx#databases.queryoperationtimeoutinsec) + * [Databases.QueryTimeoutInSec](../../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec) + * [Databases.QueryOperationTimeoutInSec](../../../server/configuration/database-configuration.mdx#databasesqueryoperationtimeoutinsec) @@ -2001,8 +2001,8 @@ Attempting multiple projection executions in the same query will result in an ex * But while calculations within a projection are allowed, having a very complex logic can impact query performance. So RavenDB limits the total time it will spend processing a query and its projections. Exceeding this time limit will fail the query. This is configurable, see the following configuration keys: - * [Databases.QueryTimeoutInSec](../../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec) - * [Databases.QueryOperationTimeoutInSec](../../../server/configuration/database-configuration.mdx#databases.queryoperationtimeoutinsec) + * [Databases.QueryTimeoutInSec](../../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec) + * [Databases.QueryOperationTimeoutInSec](../../../server/configuration/database-configuration.mdx#databasesqueryoperationtimeoutinsec) diff --git a/docs/client-api/session/querying/how-to-query.mdx b/docs/client-api/session/querying/how-to-query.mdx index 72e1c5c278..18b893700f 100644 --- a/docs/client-api/session/querying/how-to-query.mdx +++ b/docs/client-api/session/querying/how-to-query.mdx @@ -43,12 +43,12 @@ export const supportedLanguages = ["csharp", "python", "php", "nodejs"]; * Query results are **cached** by default. To disable query caching see [NoCaching](../../../client-api/session/querying/how-to-customize-query.mdx#nocaching). -* Queries are timed out after a configurable time period. See [query timeout](../../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec). +* 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#session.query) - * [Session.Advanced.DocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery) - * [Session.Advanced.RawQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) + * [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) @@ -123,7 +123,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#session.query). + See more examples [below](../../../client-api/session/querying/how-to-query.mdx#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). @@ -155,7 +155,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#session.query). + See more examples [below](../../../client-api/session/querying/how-to-query.mdx#sessionquery). @@ -556,7 +556,7 @@ from "Employees" where FirstName = "Robert" ## Session.Advanced.RawQuery -* Queries defined with [Query](../../../client-api/session/querying/how-to-query.mdx#session.query) or [DocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery) are translated by the RavenDB client to [RQL](../../../client-api/session/querying/what-is-rql.mdx) +* 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) when sent to the server. * The session also gives you a way to express the query directly in RQL using the `RawQuery` method. @@ -604,7 +604,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#session.query) method: +* Available custom methods and extensions for the session's [Query](../../../client-api/session/querying/how-to-query.mdx#sessionquery) method: * [AggregateBy](../../../client-api/session/querying/how-to-perform-a-faceted-search.mdx) * AnyAsync @@ -711,12 +711,12 @@ IRawDocumentQuery RawQuery(string query); * Query results are **cached** by default. To disable query caching see [NoCaching](../../../client-api/session/querying/how-to-customize-query.mdx#nocaching). -* Queries are timed out after a configurable time period. See [query timeout](../../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec). +* 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#session.query) - * [session.advanced.document_query](../../../client-api/session/querying/how-to-query.mdx#session.advanced.document_query) - * [session.advanced.raw_query](../../../client-api/session/querying/how-to-query.mdx#session.advanced.raw_query) + * [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) @@ -791,7 +791,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#session.query). + See more examples [below](../../../client-api/session/querying/how-to-query.mdx#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). @@ -823,7 +823,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#session.query). + See more examples [below](../../../client-api/session/querying/how-to-query.mdx#sessionquery). @@ -1076,7 +1076,7 @@ from "Employees" where FirstName = "Robert" ## session.advanced.raw_query -* Queries defined with [query](../../../client-api/session/querying/how-to-query.mdx#session.query) or [document_query](../../../client-api/session/querying/how-to-query.mdx#session.advanced.document_query) are translated by the RavenDB client to [RQL](../../../client-api/session/querying/what-is-rql.mdx) +* 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) when sent to the server. * The session also gives you a way to express the query directly in RQL using the `raw_query` method. @@ -1106,7 +1106,7 @@ employees = list( # Execute the query ## Custom methods -Available custom methods for session's [query](../../../client-api/session/querying/how-to-query.mdx#session.query) method: +Available custom methods for session's [query](../../../client-api/session/querying/how-to-query.mdx#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) @@ -1226,12 +1226,12 @@ def raw_query(self, query: str, object_type: Optional[Type[_T]] = None) -> RawDo To disable query caching see [NoCaching](../../../client-api/session/querying/how-to-customize-query.mdx#nocaching). * Queries are timed out after a configurable time period. - See [query timeout](../../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec). + 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#session.query) - * [session.advanced.documentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery) - * [session.advanced.rawQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) + * [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) @@ -1306,7 +1306,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#session.query). + See more examples [below](../../../client-api/session/querying/how-to-query.mdx#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) @@ -1339,7 +1339,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#session.query). + See more examples [below](../../../client-api/session/querying/how-to-query.mdx#sessionquery). @@ -1536,8 +1536,8 @@ from "Employees" where FirstName = "Robert" ## session.advanced.rawQuery -* Queries defined with [query](../../../client-api/session/querying/how-to-query.mdx#session.query) - or [documentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery) +* 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) when sent to the server. @@ -1567,7 +1567,7 @@ $employees = $session ## Custom methods -Available custom methods for session's [query](../../../client-api/session/querying/how-to-query.mdx#session.query) method: +Available custom methods for session's [query](../../../client-api/session/querying/how-to-query.mdx#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) @@ -1651,11 +1651,11 @@ public function rawQuery(?string $className, string $query): RawDocumentQueryInt * Query results are **cached** by default. To disable query caching see [noCaching](../../../client-api/session/querying/how-to-customize-query.mdx#nocaching). -* Queries are timed out after a configurable time period. See [query timeout](../../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec). +* 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#session.query) - * [session.advanced.rawQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) + * [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) @@ -1730,7 +1730,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#session.query). + See more examples [below](../../../client-api/session/querying/how-to-query.mdx#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). @@ -1762,7 +1762,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#session.query). + See more examples [below](../../../client-api/session/querying/how-to-query.mdx#sessionquery). @@ -1967,7 +1967,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#session.query) 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](../../../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. * The session also gives you a way to express the query directly in RQL using the `rawQuery` method. @@ -1995,7 +1995,7 @@ const employees = await session.advanced ## query API -Available methods for the session's [query](../../../client-api/session/querying/how-to-query.mdx#session.query) method: +Available methods for the session's [query](../../../client-api/session/querying/how-to-query.mdx#sessionquery) method: - addOrder - addParameter diff --git a/docs/client-api/session/querying/how-to-stream-query-results.mdx b/docs/client-api/session/querying/how-to-stream-query-results.mdx index 174dcc7782..b34c2ec3ad 100644 --- a/docs/client-api/session/querying/how-to-stream-query-results.mdx +++ b/docs/client-api/session/querying/how-to-stream-query-results.mdx @@ -527,7 +527,7 @@ IEnumerator> Stream(IRawDocumentQuery query, out StreamQue | Parameters | type | description | | - | - | - | -| **query** | [IQueryable](../../../client-api/session/querying/how-to-query.mdx#session.query), [IDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery) or [IRawDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) | The query for which to stream results | +| **query** | [IQueryable](../../../client-api/session/querying/how-to-query.mdx#sessionquery), [IDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery) or [IRawDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) | The query for which to stream results | | `out` **streamQueryStats** | [StreamQueryStatistics](../../../glossary/stream-query-statistics.mdx) | Information about performed query | | Return Value | | @@ -671,7 +671,7 @@ To stream results, use the `stream` method from the `advanced` session operation | Parameters | | | | ------------- | ------------- | ----- | -| **query** | [IDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery) or [IRawDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) | Query to stream results for. | +| **query** | [IDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery) or [IRawDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) | Query to stream results for. | | `Reference` **streamQueryStats** | StreamQueryStatistics | Information about performed query. | | Return Value | | diff --git a/docs/client-api/session/querying/sort-query-results.mdx b/docs/client-api/session/querying/sort-query-results.mdx index 03dedd3524..5b208e9399 100644 --- a/docs/client-api/session/querying/sort-query-results.mdx +++ b/docs/client-api/session/querying/sort-query-results.mdx @@ -226,7 +226,7 @@ The score details can be retrieved by either: * When using __Corax__: In order to enhance performance, this metadata property is Not included in the results by default. - To get this metadata property you must set the [Indexing.Corax.IncludeDocumentScore](../../../server/configuration/indexing-configuration.mdx#indexing.corax.includedocumentscore) configuration value to _true_. + To get this metadata property you must set the [Indexing.Corax.IncludeDocumentScore](../../../server/configuration/indexing-configuration.mdx#indexingcoraxincludedocumentscore) configuration value to _true_. Learn about the available methods for setting an indexing configuration key in this [indexing-configuration](../../../server/configuration/indexing-configuration.mdx) article. * The following example shows how to get the score from the metadata of the resulting entities that were loaded to the session: @@ -924,7 +924,7 @@ The score details can be retrieved by either: * When using **Corax**: In order to enhance performance, this metadata property is Not included in the results by default. - To get this metadata property you must set the [Indexing.Corax.IncludeDocumentScore](../../../server/configuration/indexing-configuration.mdx#indexing.corax.includedocumentscore) configuration value to `True` + To get this metadata property you must set the [Indexing.Corax.IncludeDocumentScore](../../../server/configuration/indexing-configuration.mdx#indexingcoraxincludedocumentscore) configuration value to `True` Learn about the available methods for setting an indexing configuration key in this [indexing-configuration](../../../server/configuration/indexing-configuration.mdx) article. @@ -1938,7 +1938,7 @@ The score details can be retrieved by either: * When using __Corax__: In order to enhance performance, this metadata property is Not included in the results by default. - To get this metadata property you must set the [Indexing.Corax.IncludeDocumentScore](../../../server/configuration/indexing-configuration.mdx#indexing.corax.includedocumentscore) configuration value to _true_. + To get this metadata property you must set the [Indexing.Corax.IncludeDocumentScore](../../../server/configuration/indexing-configuration.mdx#indexingcoraxincludedocumentscore) configuration value to _true_. Learn about the available methods for setting an indexing configuration key in this [indexing-configuration](../../../server/configuration/indexing-configuration.mdx) article. * The following example shows how to get the score from the metadata of the resulting entities that were loaded to the session: diff --git a/docs/client-api/session/updating-entities.mdx b/docs/client-api/session/updating-entities.mdx index 832848001b..0eaacff91d 100644 --- a/docs/client-api/session/updating-entities.mdx +++ b/docs/client-api/session/updating-entities.mdx @@ -23,7 +23,7 @@ export const supportedLanguages = ["csharp", "python", "php", "nodejs"]; * To modify existing documents: - * **Retrieve** documents from the database using [Load](../../client-api/session/loading-entities.mdx#load) or by a [Query](../../client-api/session/querying/how-to-query.mdx#session.query). + * **Retrieve** documents from the database using [Load](../../client-api/session/loading-entities.mdx#load) or by a [Query](../../client-api/session/querying/how-to-query.mdx#sessionquery). The entities loaded from the documents are added to the internal entities map that the Session manages. * **Edit** the properties you wish to change. @@ -146,7 +146,7 @@ export const supportedLanguages = ["csharp", "python", "php", "nodejs"]; * To modify existing documents: - * **Retrieve** documents from the database using [load](../../client-api/session/loading-entities.mdx#load) or by a [query](../../client-api/session/querying/how-to-query.mdx#session.query). + * **Retrieve** documents from the database using [load](../../client-api/session/loading-entities.mdx#load) or by a [query](../../client-api/session/querying/how-to-query.mdx#sessionquery). The entities loaded from the documents are added to the internal entities map that the Session manages. * **Edit** the properties you wish to change. @@ -224,7 +224,7 @@ export const supportedLanguages = ["csharp", "python", "php", "nodejs"]; * To modify existing documents: * **Retrieve** documents from the database using [load](../../client-api/session/loading-entities.mdx#load) - or by a [query](../../client-api/session/querying/how-to-query.mdx#session.query). + or by a [query](../../client-api/session/querying/how-to-query.mdx#sessionquery). The entities loaded from the documents are added to the internal entities map that the session manages. * **Edit** the properties you wish to change. @@ -311,7 +311,7 @@ try \{ * To modify existing documents: - * **Retrieve** documents from the database using [load](../../client-api/session/loading-entities.mdx#load) or by a [query](../../client-api/session/querying/how-to-query.mdx#session.query). + * **Retrieve** documents from the database using [load](../../client-api/session/loading-entities.mdx#load) or by a [query](../../client-api/session/querying/how-to-query.mdx#sessionquery). The entities loaded from the documents are added to the internal entities map that the Session manages. * **Edit** the properties you wish to change. diff --git a/docs/client-api/session/what-is-a-session-and-how-does-it-work.mdx b/docs/client-api/session/what-is-a-session-and-how-does-it-work.mdx index 9013217f0b..3455205580 100644 --- a/docs/client-api/session/what-is-a-session-and-how-does-it-work.mdx +++ b/docs/client-api/session/what-is-a-session-and-how-does-it-work.mdx @@ -282,7 +282,7 @@ Assert.Same(entity1, entity2); The phrase "session's transaction mode" refers to the type of transaction that will be executed on the server-side when `SaveChanges()` is called. As mentioned earlier, the session itself does not represent an ACID transaction. - * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) transactions. + * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) transactions. @@ -571,7 +571,7 @@ Assert.assertSame(entity1, entity2); The phrase "session's transaction mode" refers to the type of transaction that will be executed on the server-side when `saveChanges()` is called. As mentioned earlier, the session itself does not represent an ACID transaction. - * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) transactions. + * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) transactions. @@ -855,7 +855,7 @@ self.assertEqual(entity1, entity2) The phrase "session's transaction mode" refers to the type of transaction that will be executed on the server-side when `save_changes()` is called. As mentioned earlier, the session itself does not represent an ACID transaction. - * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) transactions. + * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) transactions. @@ -1149,7 +1149,7 @@ $this->assertSame($entity1, $entity2); The phrase "session's transaction mode" refers to the type of transaction that will be executed on the server-side when `saveChanges()` is called. As mentioned earlier, the session itself does not represent an ACID transaction. - * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) transactions. + * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) transactions. @@ -1497,7 +1497,7 @@ assert.equal(entity1, entity2); The phrase "session's transaction mode" refers to the type of transaction that will be executed on the server-side when `saveChanges()` is called. As mentioned earlier, the session itself does not represent an ACID transaction. - * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) transactions. + * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) transactions. diff --git a/docs/data-archival/archived-documents-and-other-features.mdx b/docs/data-archival/archived-documents-and-other-features.mdx index 34afd8aa99..0a2929913c 100644 --- a/docs/data-archival/archived-documents-and-other-features.mdx +++ b/docs/data-archival/archived-documents-and-other-features.mdx @@ -58,7 +58,7 @@ export const supportedLanguages = ["csharp"]; * **Configuring indexing behavior - Static indexes**: * **At the database level or server-wide**: To control whether static indexes process archived documents from the source collection, - set the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.static.archiveddataprocessingbehavior) + set the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingstaticarchiveddataprocessingbehavior) configuration key at either the database level or server-wide (default: `ExcludeArchived`). * Note that this setting applies only to static-indexes that are using _Documents_ as their data source. This global configuration does Not apply to static-indexes based on _Time Series_ or _Counters_, which default to `IncludeArchived`. @@ -69,7 +69,7 @@ export const supportedLanguages = ["csharp"]; * **Configuring indexing behavior - Auto indexes:** * **At the database level or server-wide**: To control whether auto-indexes process archived documents at the database level or server-wide, - set the [Indexing.Auto.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.auto.archiveddataprocessingbehavior) configuration key (default `ExcludeArchived`). + set the [Indexing.Auto.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingautoarchiveddataprocessingbehavior) configuration key (default `ExcludeArchived`). * **Per index**: Unlike static indexes, you cannot configure this behavior per auto-index, because dynamic queries (which trigger auto-index creation) do not provide a way to control this setting. @@ -80,7 +80,7 @@ export const supportedLanguages = ["csharp"]; ##### Configuring archived document processing for a static index - from the Client API You can configure how a static index handles archived documents when creating the index using the Client API. -This setting will **override** the global configuration defined by the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.static.archiveddataprocessingbehavior) configuration key. +This setting will **override** the global configuration defined by the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingstaticarchiveddataprocessingbehavior) configuration key. @@ -280,7 +280,7 @@ store.Maintenance.Send(new PutIndexesOperation(indexDefinition)); ##### Configuring archived document processing for a static index - from the Studio You can configure how a static index handles archived documents directly from the Studio. -This setting will **override** the global configuration defined by the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.static.archiveddataprocessingbehavior) configuration key. +This setting will **override** the global configuration defined by the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingstaticarchiveddataprocessingbehavior) configuration key. ![Configure index](./assets/configure-static-index.png) @@ -306,7 +306,7 @@ This setting will **override** the global configuration defined by the [Indexing * **Dynamic queries (auto-indexes)**: * When making a dynamic query, RavenDB creates an auto-index to serve it. - Whether that index processes archived documents depends on the value of the [Indexing.Auto.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.auto.archiveddataprocessingbehavior) configuration key at the time the query is made. + Whether that index processes archived documents depends on the value of the [Indexing.Auto.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingautoarchiveddataprocessingbehavior) configuration key at the time the query is made. * Once created, the auto-index retains that behavior. Query results will continue to reflect the configuration that was in effect when the index was first built - even if the setting is changed later. * Learn more about dynamic queries in [Query a collection - with filtering](../client-api/session/querying/how-to-query.mdx#dynamicQuery). @@ -314,7 +314,7 @@ This setting will **override** the global configuration defined by the [Indexing * **Querying static-indexes**: * When querying a static-index, the results will include, exclude, or consist solely of archived documents depending on how the static-index was configured. The index behavior is determined by: - * the value of the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.static.archiveddataprocessingbehavior) configuration key at the time the static-index was created, or - + * the value of the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingstaticarchiveddataprocessingbehavior) configuration key at the time the static-index was created, or - * the explicit setting in the index definition, which overrides the global configuration key. * The index's archived data processing behavior can be modified after its creation using the Studio or the Client API. @@ -340,7 +340,7 @@ This setting will **override** the global configuration defined by the [Indexing ##### Configuring archived document processing for a data subscription task - from the Client API You can configure how a subscription task handles archived documents when creating the subscription using the Client API. -This setting will **override** the global configuration defined by the [Subscriptions.ArchivedDataProcessingBehavior](../server/configuration/subscription-configuration.mdx#subscriptions.archiveddataprocessingbehavior) configuration key. +This setting will **override** the global configuration defined by the [Subscriptions.ArchivedDataProcessingBehavior](../server/configuration/subscription-configuration.mdx#subscriptionsarchiveddataprocessingbehavior) configuration key. @@ -384,7 +384,7 @@ Example: ##### Configuring archived document processing for a data subscription task - from the Studio You can configure how a subscription task handles archived documents directly from the Studio. -This setting will **override** the global configuration defined by the [Subscriptions.ArchivedDataProcessingBehavior](../server/configuration/subscription-configuration.mdx#subscriptions.archiveddataprocessingbehavior) configuration key. +This setting will **override** the global configuration defined by the [Subscriptions.ArchivedDataProcessingBehavior](../server/configuration/subscription-configuration.mdx#subscriptionsarchiveddataprocessingbehavior) configuration key. ![Configure subscription](./assets/configure-subscription.png) diff --git a/docs/data-archival/unarchiving-documents.mdx b/docs/data-archival/unarchiving-documents.mdx index a5e894a9ec..4dbced57b9 100644 --- a/docs/data-archival/unarchiving-documents.mdx +++ b/docs/data-archival/unarchiving-documents.mdx @@ -180,7 +180,7 @@ It will unarchive all archived documents in the _Orders_ collection. As a result, no documents will be unarchived by the patch operation. * For example, the following patch query uses a dynamic query that creates an auto-index. - If the [Indexing.Auto.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.auto.archiveddataprocessingbehavior) configuration key is set to its default `ExcludeArchived` value, + If the [Indexing.Auto.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingautoarchiveddataprocessingbehavior) configuration key is set to its default `ExcludeArchived` value, then even if archived documents exist in the _Orders_ collection with `ShipTo.Country == 'USA'`, they will not be matched - because the auto-index does not include them - and the patch operation will not unarchive any documents. @@ -208,9 +208,9 @@ Two possible workarounds are: Use this option only if including archived documents in the index aligns with your indexing strategy. **For auto-indexes**: - Set the [Indexing.Auto.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.auto.archiveddataprocessingbehavior) configuration key to `IncludeArchived`. + Set the [Indexing.Auto.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingautoarchiveddataprocessingbehavior) configuration key to `IncludeArchived`. **For static-indexes**: - Set the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.static.archiveddataprocessingbehavior) configuration key to `IncludeArchived`, + Set the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingstaticarchiveddataprocessingbehavior) configuration key to `IncludeArchived`, or - configure the definition of the specific static-index to include archived documents. See [Archived documents and indexing](../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-indexing). diff --git a/docs/document-extensions/counters/counters-and-other-features.mdx b/docs/document-extensions/counters/counters-and-other-features.mdx index 0366377069..d04c16f05e 100644 --- a/docs/document-extensions/counters/counters-and-other-features.mdx +++ b/docs/document-extensions/counters/counters-and-other-features.mdx @@ -58,7 +58,7 @@ Create queries **using code**, or send the server **raw queries** for execution. * 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. -* Use [Session.Query](../../client-api/session/querying/how-to-query.mdx#session.query) to code queries yourself. +* Use [Session.Query](../../client-api/session/querying/how-to-query.mdx#sessionquery) to code queries yourself. * **Returned Counter Value**: **Accumulated** A Counter's value is returned as a single sum, with no specification of the Counter's value on each node. @@ -83,7 +83,7 @@ Create queries **using code**, or send the server **raw queries** for execution. -* Use [RawQuery](../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) to send the server raw RQL expressions for execution. +* Use [RawQuery](../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) to send the server raw RQL expressions for execution. * You can use the `counter` method. **Returned Counter Value**: **Accumulated** @@ -750,7 +750,7 @@ Create queries **using code**, or send the server **raw queries** for execution. * 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. -* Use [session.query](../../client-api/session/querying/how-to-query.mdx#session.query) to code queries yourself. +* Use [session.query](../../client-api/session/querying/how-to-query.mdx#sessionquery) to code queries yourself. * **Returned Counter Value**: **Accumulated** A Counter's value is returned as a single sum, with no specification of the Counter's value on each node. @@ -762,7 +762,7 @@ Create queries **using code**, or send the server **raw queries** for execution. -* Use [RawQuery](../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) to send the server raw RQL expressions for execution. +* Use [RawQuery](../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) to send the server raw RQL expressions for execution. * You can use the `counter` method. **Returned Counter Value**: **Accumulated** @@ -1051,7 +1051,7 @@ Send the server **raw queries** for execution. * 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. -* Use [RawQuery](../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) to send the server raw RQL expressions for execution. +* Use [RawQuery](../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) to send the server raw RQL expressions for execution. * You can use the `counter` method. **Returned Counter Value**: **Accumulated** @@ -1283,7 +1283,7 @@ Create queries **using code**, or send the server **raw queries** for execution. * 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. -* Use [Session.Query](../../client-api/session/querying/how-to-query.mdx#session.query) to code queries yourself. +* Use [Session.Query](../../client-api/session/querying/how-to-query.mdx#sessionquery) to code queries yourself. * **Returned Counter Value**: **Accumulated** A Counter's value is returned as a single sum, with no specification of the Counter's value on each node. @@ -1300,7 +1300,7 @@ for (let counterValue in queryResults) \{ -* Use [RawQuery](../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) to send the server raw RQL expressions for execution. +* Use [RawQuery](../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) to send the server raw RQL expressions for execution. * You can use the `counter` method. **Returned Counter Value**: **Accumulated** diff --git a/docs/document-extensions/revisions/client-api/overview.mdx b/docs/document-extensions/revisions/client-api/overview.mdx index 9689589e8e..1faa78fdb3 100644 --- a/docs/document-extensions/revisions/client-api/overview.mdx +++ b/docs/document-extensions/revisions/client-api/overview.mdx @@ -49,7 +49,7 @@ export const supportedLanguages = ["csharp", "java", "python", "php", "nodejs"]; * **Include revisions**: * [IncludeRevisions](../../../document-extensions/revisions/client-api/session/including.mdx#section) - include revisions when retrieving documents via `Session.Load` or `Session.Query`. - * [RawQuery](../../../document-extensions/revisions/client-api/session/including.mdx#including-revisions-with-session.advanced.rawquery) - Learn how to include revisions when retrieving documents via raw queries. + * [RawQuery](../../../document-extensions/revisions/client-api/session/including.mdx#including-revisions-with-sessionadvancedrawquery) - Learn how to include revisions when retrieving documents via raw queries. * **Count revisions**: * [GetCountFor](../../../document-extensions/revisions/client-api/session/counting.mdx#getcountfor) - get the number of revisions kept for a document. @@ -103,7 +103,7 @@ export const supportedLanguages = ["csharp", "java", "python", "php", "nodejs"]; * [Including revisions](../../../document-extensions/revisions/client-api/session/including.mdx) * [IncludeRevisions](../../../document-extensions/revisions/client-api/session/including.mdx#section) Use this method to include document revisions when retrieving documents via `Session.Load` or `Session.Query`. - * [RawQuery](../../../document-extensions/revisions/client-api/session/including.mdx#including-revisions-with-session.advanced.rawquery) + * [RawQuery](../../../document-extensions/revisions/client-api/session/including.mdx#including-revisions-with-sessionadvancedrawquery) Learn here how to include revisions with documents retrieved via raw queries. @@ -232,7 +232,7 @@ about creating a revision even if revision configuration is disabled. * **Include revisions**: * [includeRevisions](../../../document-extensions/revisions/client-api/session/including.mdx#section) - include revisions when retrieving documents via `session.load` or `session.query`. - * [rawQuery](../../../document-extensions/revisions/client-api/session/including.mdx#including-revisions-with-session.advanced.rawquery) - Learn how to include revisions when retrieving documents via raw queries. + * [rawQuery](../../../document-extensions/revisions/client-api/session/including.mdx#including-revisions-with-sessionadvancedrawquery) - Learn how to include revisions when retrieving documents via raw queries. * **Count revisions**: * [getCountFor](../../../document-extensions/revisions/client-api/session/counting.mdx#getcountfor) - get the number of revisions kept for a document. diff --git a/docs/document-extensions/revisions/overview.mdx b/docs/document-extensions/revisions/overview.mdx index dfde708556..6561a85f3a 100644 --- a/docs/document-extensions/revisions/overview.mdx +++ b/docs/document-extensions/revisions/overview.mdx @@ -212,7 +212,7 @@ using the same blittable JSON document format as regular documents. ##### Revisions Compression * By default, revisions are compressed. - This setting can be customized server-wide via the [CompressRevisionsDefault](../../server/configuration/database-configuration.mdx#databases.compression.compressrevisionsdefault) configuration key. + This setting can be customized server-wide via the [CompressRevisionsDefault](../../server/configuration/database-configuration.mdx#databasescompressioncompressrevisionsdefault) configuration key. * At the database level, revisions compression can be customized via the database record, as shown in [this example](../../server/storage/documents-compression.mdx#set-compression-for-selected-collections). * Individual fields are compressed as they are compressed in regular documents: @@ -537,7 +537,7 @@ using the same blittable JSON document format as regular documents. ##### Revisions Compression * By default, revisions are compressed. - This setting can be customized server-wide via the [CompressRevisionsDefault](../../server/configuration/database-configuration.mdx#databases.compression.compressrevisionsdefault) configuration key. + This setting can be customized server-wide via the [CompressRevisionsDefault](../../server/configuration/database-configuration.mdx#databasescompressioncompressrevisionsdefault) configuration key. * At the database level, revisions compression can be customized via the database record, as shown in [this example](../../server/storage/documents-compression.mdx#set-compression-for-selected-collections). * Individual fields are compressed as they are compressed in regular documents: @@ -561,7 +561,7 @@ Read [here](../../document-extensions/revisions/revisions-and-other-features.mdx * **Revisions compression** * Revisions are compressed by default. - Learn [here](../../server/configuration/database-configuration.mdx#databases.compression.compressrevisionsdefault) + Learn [here](../../server/configuration/database-configuration.mdx#databasescompressioncompressrevisionsdefault) how to toggle this database option on and off. * Learn [here](../../server/storage/documents-compression.mdx) how to apply Document Compression to revisions. * Individual fields are compressed as they are compressed in regular documents: @@ -822,7 +822,7 @@ using the same blittable JSON document format as regular documents. ##### Revisions Compression * By default, revisions are compressed. - This setting can be customized server-wide via the [CompressRevisionsDefault](../../server/configuration/database-configuration.mdx#databases.compression.compressrevisionsdefault) configuration key. + This setting can be customized server-wide via the [CompressRevisionsDefault](../../server/configuration/database-configuration.mdx#databasescompressioncompressrevisionsdefault) configuration key. * At the database level, revisions compression can be customized via the database record, as shown in [this example](../../server/storage/documents-compression.mdx#set-compression-for-selected-collections). * Individual fields are compressed as they are compressed in regular documents: diff --git a/docs/document-extensions/timeseries/client-api/session/include/with-raw-queries.mdx b/docs/document-extensions/timeseries/client-api/session/include/with-raw-queries.mdx index a5671a523a..9e253dbd96 100644 --- a/docs/document-extensions/timeseries/client-api/session/include/with-raw-queries.mdx +++ b/docs/document-extensions/timeseries/client-api/session/include/with-raw-queries.mdx @@ -22,7 +22,7 @@ export const supportedLanguages = ["csharp", "nodejs"]; * Use `include timeseries` in your RQL expression in order to include time series data when making - a raw query via [session.Advanced.RawQuery](../../../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery). + a raw query via [session.Advanced.RawQuery](../../../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery). * The included time series data is stored within the session and can be provided instantly when requested without any additional server calls. @@ -94,7 +94,7 @@ and _include_ entries from the document's "HeartRates" time series. * Use `include timeseries` in your RQL expression in order to include time series data when making - a raw query via [session.advanced.rawQuery](../../../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery). + a raw query via [session.advanced.rawQuery](../../../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery). * The included time series data is stored within the session and can be provided instantly when requested without any additional server calls. 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 b7569b7e18..877cbad54f 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#timeseries.increment) +* You can use the Javascript [timeseries.increment](../../../../document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx#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). @@ -34,7 +34,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * 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#timeseries.increment) + * [`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) @@ -112,7 +112,7 @@ void Increment(double value); ## Usage Sample In this sample we use -[session.Advanced.Defer](../../../../document-extensions/timeseries/client-api/session/patch.mdx#patching-using-session.advanced.defer) +[session.Advanced.Defer](../../../../document-extensions/timeseries/client-api/session/patch.mdx#patching-using-sessionadvanceddefer) to patch an incremental time series. We go through a series of collected stock prices, and add a **2** factor to each collected stock price, that has been originally miscalculated. 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 efede0c0b7..a9ed8a6c16 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,7 +20,7 @@ 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#incrementaltimeseriesfor.delete) + * [`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) 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 432948cff9..5ce3b581be 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,7 +30,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [`IncrementalTimeSeriesFor.Get`](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx#incrementaltimeseriesfor.get) + * [`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) * [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 507e3a5138..65b9b75455 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,7 +26,7 @@ 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#timeseriesfor.append) + * [`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) diff --git a/docs/document-extensions/timeseries/incremental-time-series/overview.mdx b/docs/document-extensions/timeseries/incremental-time-series/overview.mdx index e52ae48c0a..30cb6c0df0 100644 --- a/docs/document-extensions/timeseries/incremental-time-series/overview.mdx +++ b/docs/document-extensions/timeseries/incremental-time-series/overview.mdx @@ -123,7 +123,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Incremental: Rollup policies can be created as above. However, the resulting rollup time series is non incremental. - It can be handled via [TimeSeriesFor](../../../document-extensions/timeseries/client-api/session/append.mdx#timeseriesfor.append), not + It can be handled via [TimeSeriesFor](../../../document-extensions/timeseries/client-api/session/append.mdx#timeseriesforappend), not [IncrementalTimeSeriesFor](../../../document-extensions/timeseries/incremental-time-series/client-api/session/overview.mdx#methods), and its values can no longer be [Incremented](../../../document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx). diff --git a/docs/document-extensions/timeseries/querying/stream-timeseries.mdx b/docs/document-extensions/timeseries/querying/stream-timeseries.mdx index b0950da419..8c70274601 100644 --- a/docs/document-extensions/timeseries/querying/stream-timeseries.mdx +++ b/docs/document-extensions/timeseries/querying/stream-timeseries.mdx @@ -85,7 +85,7 @@ IEnumerator> Stream( | Parameters | Type | Description | | - | - | - | -| **query** | [IQueryable](../../../client-api/session/querying/how-to-query.mdx#session.query), [IDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery) or [IRawDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) | Query to stream results for. | +| **query** | [IQueryable](../../../client-api/session/querying/how-to-query.mdx#sessionquery), [IDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery) or [IRawDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) | Query to stream results for. | | **streamQueryStats** | `out` [StreamQueryStatistics](../../../glossary/stream-query-statistics.mdx) | Information about performed query. | | Return Value | Description | @@ -243,7 +243,7 @@ found [here](../../../client-api/session/querying/how-to-stream-query-results.md | Parameters | | | | ------------- | ------------- | ----- | -| **query** | [IDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery) or [IRawDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) | Query to stream results for. | +| **query** | [IDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery) or [IRawDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) | Query to stream results for. | | `Reference` **streamQueryStats** | StreamQueryStatistics | Information about performed query. | | Return Value | | diff --git a/docs/indexes/boosting.mdx b/docs/indexes/boosting.mdx index e48c76efcc..bed948bf36 100644 --- a/docs/indexes/boosting.mdx +++ b/docs/indexes/boosting.mdx @@ -287,7 +287,7 @@ where ShipToCountry == "poland" or CompanyCountry == "portugal" * By default, whenever boosting is applied, either via dynamic querying or when querying an index that has a boosting factor in its definition, the results will be automatically ordered by the score. -* This behavior can be modified using the [OrderByScoreAutomaticallyWhenBoostingIsInvolved](../server/configuration/indexing-configuration.mdx#indexing.orderbyscoreautomaticallywhenboostingisinvolved) +* This behavior can be modified using the [OrderByScoreAutomaticallyWhenBoostingIsInvolved](../server/configuration/indexing-configuration.mdx#indexingorderbyscoreautomaticallywhenboostingisinvolved) configuration key. * Refer to the [Get resulting score](../client-api/session/querying/sort-query-results.mdx#get-resulting-score) @@ -388,7 +388,7 @@ Boosting is also available at the query level. * By default, whenever boosting is involved, either via a dynamic query or when querying an index that has a boosting factor in its definition, the results will be automatically ordered by the score. -* This behavior can be modified using the [OrderByScoreAutomaticallyWhenBoostingIsInvolved](../server/configuration/indexing-configuration.mdx#indexing.orderbyscoreautomaticallywhenboostingisinvolved) +* This behavior can be modified using the [OrderByScoreAutomaticallyWhenBoostingIsInvolved](../server/configuration/indexing-configuration.mdx#indexingorderbyscoreautomaticallywhenboostingisinvolved) configuration key. @@ -686,7 +686,7 @@ where ShipToCountry == "poland" or CompanyCountry == "portugal" * By default, whenever boosting is applied, either via dynamic querying or when querying an index that has a boosting factor in its definition, the results will be automatically ordered by the score. -* This behavior can be modified using the [OrderByScoreAutomaticallyWhenBoostingIsInvolved](../server/configuration/indexing-configuration.mdx#indexing.orderbyscoreautomaticallywhenboostingisinvolved) +* This behavior can be modified using the [OrderByScoreAutomaticallyWhenBoostingIsInvolved](../server/configuration/indexing-configuration.mdx#indexingorderbyscoreautomaticallywhenboostingisinvolved) configuration key. * Refer to the [Get resulting score](../client-api/session/querying/sort-query-results.mdx#get-resulting-score) @@ -859,7 +859,7 @@ where ShipToCountry == "poland" or CompanyCountry == "portugal" * By default, whenever boosting is applied, either via dynamic querying or when querying an index that has a boosting factor in its definition, the results will be automatically ordered by the score. -* This behavior can be modified using the [OrderByScoreAutomaticallyWhenBoostingIsInvolved](../server/configuration/indexing-configuration.mdx#indexing.orderbyscoreautomaticallywhenboostingisinvolved) +* This behavior can be modified using the [OrderByScoreAutomaticallyWhenBoostingIsInvolved](../server/configuration/indexing-configuration.mdx#indexingorderbyscoreautomaticallywhenboostingisinvolved) configuration key. * Refer to the [Get resulting score](../client-api/session/querying/sort-query-results.mdx#get-resulting-score) diff --git a/docs/indexes/creating-and-deploying.mdx b/docs/indexes/creating-and-deploying.mdx index b48e332930..c4968e7d39 100644 --- a/docs/indexes/creating-and-deploying.mdx +++ b/docs/indexes/creating-and-deploying.mdx @@ -487,12 +487,12 @@ where FirstName = "Robert" and LastName = "King" * This is done in order to avoid marking indexes as idle for databases that were offline for a long period of time, as well as for databases that were just restored from a snapshot or a backup. * To set the time before marking an index as idle, use the - [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key. + [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key. Setting this value too high is not recommended, as it may lead to performance degradation by causing unnecessary and redundant work for the indexes. * An `idle` auto-index will resume its work and return to `normal` state upon its next query, or when resetting the index. * If not resumed, the idle auto-index will be deleted by the server after the time period defined in the - [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key + [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key (72 hours by default). @@ -507,7 +507,7 @@ where FirstName = "Robert" and LastName = "King" **How to disable**: -* You can disable auto-indexes by setting the [Indexing.DisableQueryOptimizerGeneratedIndexes](../server/configuration/indexing-configuration.mdx#indexing.disablequeryoptimizergeneratedindexes) configuration key. +* You can disable auto-indexes by setting the [Indexing.DisableQueryOptimizerGeneratedIndexes](../server/configuration/indexing-configuration.mdx#indexingdisablequeryoptimizergeneratedindexes) configuration key. This will affect all queries made both from the **Client API** and the **Studio**. * Alternatively, you can disable auto-indexes from the Studio. @@ -1187,12 +1187,12 @@ where FirstName = "Robert" and LastName = "King" * This is done in order to avoid marking indexes as idle for databases that were offline for a long period of time, as well as for databases that were just restored from a snapshot or a backup. * To set the time before marking an index as idle, use the - [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key. + [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key. Setting this value too high is not recommended, as it may lead to performance degradation by causing unnecessary and redundant work for the indexes. * An `idle` auto-index will resume its work and return to `normal` state upon its next query, or when resetting the index. * If not resumed, the idle auto-index will be deleted by the server after the time period defined in the - [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key + [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key (72 hours by default). @@ -1207,7 +1207,7 @@ where FirstName = "Robert" and LastName = "King" **How to disable**: -* You can disable auto-indexes by setting the [Indexing.DisableQueryOptimizerGeneratedIndexes](../server/configuration/indexing-configuration.mdx#indexing.disablequeryoptimizergeneratedindexes) configuration key. +* You can disable auto-indexes by setting the [Indexing.DisableQueryOptimizerGeneratedIndexes](../server/configuration/indexing-configuration.mdx#indexingdisablequeryoptimizergeneratedindexes) configuration key. This will affect all queries made both from the **Client API** and the **Studio**. * Alternatively, you can disable auto-indexes from the Studio. diff --git a/docs/indexes/index-administration.mdx b/docs/indexes/index-administration.mdx index 8e066eb404..9b4979930d 100644 --- a/docs/indexes/index-administration.mdx +++ b/docs/indexes/index-administration.mdx @@ -150,7 +150,7 @@ An index can be in one of the following states: * Specifically, an **auto-index** is marked as _'Idle'_ when the time difference between its last-query-time and the most recent time the database was queried (using any other index) exceeds a configurable threshold. This threshold is set by the - [Indexing.TimeToWaitBeforeMarkingAutoIndexAsIdleInMin](../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforemarkingautoindexasidleinmin) configuration key (30 minutes by default). + [Indexing.TimeToWaitBeforeMarkingAutoIndexAsIdleInMin](../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforemarkingautoindexasidleinmin) configuration key (30 minutes by default). * This mechanism is designed to prevent auto-indexes from being marked as idle in databases that were offline for a long period, had no new data to index, were not queried, or were recently restored from a snapshot or backup. @@ -164,11 +164,11 @@ An index can be in one of the following states: * When [the database is reloaded](../studio/database/settings/database-settings.mdx#how-to-reload-the-database). * If the idle auto-index is Not returned to the _'Normal'_ state, the server will **delete** it after a configurable time period, - set by the [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key (72 hours by default). + set by the [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key (72 hours by default). * Note: The server evaluates whether an auto-index should be marked as idle, or whether an idle auto-index should be deleted, - at intervals defined by the [Indexing.CleanupIntervalInMin](../server/configuration/indexing-configuration.mdx#indexing.cleanupintervalinmin) configuration key (10 minutes by default). + at intervals defined by the [Indexing.CleanupIntervalInMin](../server/configuration/indexing-configuration.mdx#indexingcleanupintervalinmin) configuration key (10 minutes by default). If _TimeToWaitBeforeMarkingAutoIndexAsIdleInMin_ or _TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs_ are set to values smaller than the cleanup interval, the index will be marked as idle or deleted only after the cleanup interval elapses. @@ -201,8 +201,8 @@ An index can be in one of the following states: **Expert configuration options**: -* [Server.IndexingAffinityMask](../server/configuration/server-configuration.mdx#server.indexingaffinitymask) - Control the affinity mask of indexing threads -* [Server.NumberOfUnusedCoresByIndexes](../server/configuration/server-configuration.mdx#server.numberofunusedcoresbyindexes) - Set the number of cores that _won't_ be used by indexes +* [Server.IndexingAffinityMask](../server/configuration/server-configuration.mdx#serverindexingaffinitymask) - Control the affinity mask of indexing threads +* [Server.NumberOfUnusedCoresByIndexes](../server/configuration/server-configuration.mdx#servernumberofunusedcoresbyindexes) - Set the number of cores that _won't_ be used by indexes diff --git a/docs/indexes/index-throttling.mdx b/docs/indexes/index-throttling.mdx index dd14345adf..bfd24f3fa0 100644 --- a/docs/indexes/index-throttling.mdx +++ b/docs/indexes/index-throttling.mdx @@ -57,7 +57,7 @@ They are therefore expected to remain stale longer than indexes that are process ## Throttling and Batches -The delay in index procession increases the size of Item [batches](../server/configuration/indexing-configuration.mdx#indexing.mapbatchsize) +The delay in index procession increases the size of Item [batches](../server/configuration/indexing-configuration.mdx#indexingmapbatchsize) that are processed during indexing intervals. In special cases, throttled indexes' batches are processed without delay. @@ -72,7 +72,7 @@ In special cases, throttled indexes' batches are processed without delay. ## Setting Index Throttling ### Server-Wide Index Throttling - Index Throttling can be set server-wide using a designated [configuration option](../server/configuration/configuration-options.mdx#settings.json). + Index Throttling can be set server-wide using a designated [configuration option](../server/configuration/configuration-options.mdx#settingsjson). Setting the server-wide configuration option will apply to all databases on a given node. * Set the index throttling time interval in Milliseconds using the `Indexing.Throttling.TimeIntervalInMs` configuration option, e.g.: @@ -129,7 +129,7 @@ and [database](../indexes/index-throttling.mdx#index-throttling-per-database) se The batch size can be left for RavenDB to decide, or you can set it yourself using - the [Indexing.MapBatchSize](../server/configuration/indexing-configuration.mdx#indexing.mapbatchsize) property. + the [Indexing.MapBatchSize](../server/configuration/indexing-configuration.mdx#indexingmapbatchsize) property. {`Configuration = new IndexConfiguration diff --git a/docs/indexes/indexing-basics.mdx b/docs/indexes/indexing-basics.mdx index 625990b41d..c5f641bf78 100644 --- a/docs/indexes/indexing-basics.mdx +++ b/docs/indexes/indexing-basics.mdx @@ -34,7 +34,7 @@ You can read more about stale indexes [here](../indexes/stale-indexes.mdx). ## Querying -RavenDB uses `Raven Query Language (RQL)`, an SQL-like querying language for querying. The easiest way for us would be to expose a method in which you could pass your RQL-flavored query as a string (we [did](../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) that) and do not bother about anything else. +RavenDB uses `Raven Query Language (RQL)`, an SQL-like querying language for querying. The easiest way for us would be to expose a method in which you could pass your RQL-flavored query as a string (we [did](../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) that) and do not bother about anything else. The fact is that we did not stop at this point. We went much further by exposing LINQ-based querying with strong-type support that hides all Lucene syntax complexity: @@ -66,7 +66,7 @@ where FirstName = 'Robert' -You can also create queries manually by using [DocumentQuery](../client-api/session/querying/document-query/what-is-document-query.mdx) or [RawQuery](../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery), both available as a part of advanced session operations: +You can also create queries manually by using [DocumentQuery](../client-api/session/querying/document-query/what-is-document-query.mdx) or [RawQuery](../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery), both available as a part of advanced session operations: @@ -132,7 +132,7 @@ You can read more about stale indexes [here](../indexes/stale-indexes.mdx). ## Querying -RavenDB uses `Raven Query Language (RQL)`, an SQL-like querying language for querying. The easiest way for us would be to expose a method in which you could pass your RQL-flavored query as a string (we [did](../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) that) and do not bother about anything else. +RavenDB uses `Raven Query Language (RQL)`, an SQL-like querying language for querying. The easiest way for us would be to expose a method in which you could pass your RQL-flavored query as a string (we [did](../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) that) and do not bother about anything else. The fact is that we did not stop at this point. We went much further, by exposing querying methods that hides all Lucene syntax complexity: @@ -154,7 +154,7 @@ where FirstName = 'Robert' -You can also create queries by using [RawQuery](../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery). It is available as a part of advanced session operations: +You can also create queries by using [RawQuery](../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery). It is available as a part of advanced session operations: @@ -209,7 +209,7 @@ You can read more about stale indexes [here](../indexes/stale-indexes.mdx). ## Querying -RavenDB uses `Raven Query Language (RQL)`, an SQL-like querying language for querying. The easiest way for us would be to expose a method in which you could pass your RQL-flavored query as a string (we [did](../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) that) and do not bother about anything else. +RavenDB uses `Raven Query Language (RQL)`, an SQL-like querying language for querying. The easiest way for us would be to expose a method in which you could pass your RQL-flavored query as a string (we [did](../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) that) and do not bother about anything else. The fact is that we did not stop at this point. We went much further, by exposing querying methods that hides all Lucene syntax complexity: @@ -231,7 +231,7 @@ where FirstName = 'Robert' -You can also create queries by using [RawQuery](../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery). It is available as a part of advanced session operations: +You can also create queries by using [RawQuery](../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery). It is available as a part of advanced session operations: diff --git a/docs/indexes/indexing-nested-data.mdx b/docs/indexes/indexing-nested-data.mdx index 162499432d..d3ed554d11 100644 --- a/docs/indexes/indexing-nested-data.mdx +++ b/docs/indexes/indexing-nested-data.mdx @@ -563,7 +563,7 @@ where Color == "black" RavenDB will issue a **High indexing fanout ratio** alert in the Studio notification center. * You can control when this performance hint is created by setting the - [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../server/configuration/performance-hints-configuration.mdx#performancehints.indexing.maxindexoutputsperdocument) configuration key + [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../server/configuration/performance-hints-configuration.mdx#performancehintsindexingmaxindexoutputsperdocument) configuration key (default is 1024). * So, for example, adding another OnlineShop document with a `tShirt` object containing 1025 items @@ -1135,7 +1135,7 @@ where Color == "black" RavenDB will issue a **High indexing fanout ratio** alert in the Studio notification center. * You can control when this performance hint is created by setting the - [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../server/configuration/performance-hints-configuration.mdx#performancehints.indexing.maxindexoutputsperdocument) configuration key + [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../server/configuration/performance-hints-configuration.mdx#performancehintsindexingmaxindexoutputsperdocument) configuration key (default is 1024). * So, for example, adding another OnlineShop document with a `tShirt` object containing 1025 items @@ -1757,7 +1757,7 @@ where Color == "black" RavenDB will issue a **High indexing fanout ratio** alert in the Studio notification center. * You can control when this performance hint is created by setting the - [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../server/configuration/performance-hints-configuration.mdx#performancehints.indexing.maxindexoutputsperdocument) configuration key + [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../server/configuration/performance-hints-configuration.mdx#performancehintsindexingmaxindexoutputsperdocument) configuration key (default is 1024). * So, for example, adding another OnlineShop document with a `tShirt` object containing 1025 items @@ -2154,7 +2154,7 @@ where color == "black" RavenDB will issue a **High indexing fanout ratio** alert in the Studio notification center. * You can control when this performance hint is created by setting the - [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../server/configuration/performance-hints-configuration.mdx#performancehints.indexing.maxindexoutputsperdocument) configuration key + [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../server/configuration/performance-hints-configuration.mdx#performancehintsindexingmaxindexoutputsperdocument) configuration key (default is 1024). * So, for example, adding another OnlineShop document with a `tShirt` object containing 1025 items diff --git a/docs/indexes/javascript-indexes.mdx b/docs/indexes/javascript-indexes.mdx index e92d2eef48..d16fc54618 100644 --- a/docs/indexes/javascript-indexes.mdx +++ b/docs/indexes/javascript-indexes.mdx @@ -73,7 +73,7 @@ export const supportedLanguages = ["csharp", "java"]; while **C# static indexes** require a [User/Admin](../server/security/authorization/security-clearance-and-permissions.mdx#section) certificate or higher. * To restrict the creation of JavaScript indexes to database admins (and above), - set the [Indexing.Static.RequireAdminToDeployJavaScriptIndexes](../server/configuration/indexing-configuration.mdx#indexing.static.requireadmintodeployjavascriptindexes) configuration to `true`. + set the [Indexing.Static.RequireAdminToDeployJavaScriptIndexes](../server/configuration/indexing-configuration.mdx#indexingstaticrequireadmintodeployjavascriptindexes) configuration to `true`. * All other capabilities and features of JavaScript indexes are identical to those of [C# indexes](../indexes/indexing-basics.mdx). @@ -231,7 +231,7 @@ public class BlogPostComment #### Example III - Map index - with inline string compilation * To define a JavaScript index using inline string compilation, - you must set the [Indexing.AllowStringCompilation](../server/configuration/indexing-configuration.mdx#indexing.allowstringcompilation) configuration key to _true_. + you must set the [Indexing.AllowStringCompilation](../server/configuration/indexing-configuration.mdx#indexingallowstringcompilation) configuration key to _true_. * The following indexes use inline string compilation to evaluate whether each product’s `UnitsInStock` is low. diff --git a/docs/indexes/map-indexes.mdx b/docs/indexes/map-indexes.mdx index 28bfe803e9..9ffcdb8431 100644 --- a/docs/indexes/map-indexes.mdx +++ b/docs/indexes/map-indexes.mdx @@ -855,10 +855,10 @@ Learn more [here](../indexes/indexing-related-documents.mdx). ## Indexing Missing Fields By default, indexes will not index a document that contains none of the specified fields. This behavior can be changed -using the [Indexing.IndexEmptyEntries](../server/configuration/indexing-configuration.mdx#indexing.indexemptyentries) +using the [Indexing.IndexEmptyEntries](../server/configuration/indexing-configuration.mdx#indexingindexemptyentries) configuration option. -The option [Indexing.IndexMissingFieldsAsNull](../server/configuration/indexing-configuration.mdx#indexing.indexmissingfieldsasnull) +The option [Indexing.IndexMissingFieldsAsNull](../server/configuration/indexing-configuration.mdx#indexingindexmissingfieldsasnull) determines whether missing fields in documents are indexed with the value `null`, or not indexed at all. @@ -2082,10 +2082,10 @@ Learn more [here](../indexes/indexing-related-documents.mdx). ## Indexing Missing Fields By default, indexes will not index a document that contains none of the specified fields. This behavior can be changed -using the [Indexing.IndexEmptyEntries](../server/configuration/indexing-configuration.mdx#indexing.indexemptyentries) +using the [Indexing.IndexEmptyEntries](../server/configuration/indexing-configuration.mdx#indexingindexemptyentries) configuration option. -The option [Indexing.IndexMissingFieldsAsNull](../server/configuration/indexing-configuration.mdx#indexing.indexmissingfieldsasnull) +The option [Indexing.IndexMissingFieldsAsNull](../server/configuration/indexing-configuration.mdx#indexingindexmissingfieldsasnull) determines whether missing fields in documents are indexed with the value `null`, or not indexed at all. @@ -2869,10 +2869,10 @@ Learn more [here](../indexes/indexing-related-documents.mdx). ## Indexing Missing Fields By default, indexes will not index a document that contains none of the specified fields. This behavior can be changed -using the [Indexing.IndexEmptyEntries](../server/configuration/indexing-configuration.mdx#indexing.indexemptyentries) +using the [Indexing.IndexEmptyEntries](../server/configuration/indexing-configuration.mdx#indexingindexemptyentries) configuration option. -The option [Indexing.IndexMissingFieldsAsNull](../server/configuration/indexing-configuration.mdx#indexing.indexmissingfieldsasnull) +The option [Indexing.IndexMissingFieldsAsNull](../server/configuration/indexing-configuration.mdx#indexingindexmissingfieldsasnull) determines whether missing fields in documents are indexed with the value `null`, or not indexed at all. @@ -3246,10 +3246,10 @@ If a document relationship is represented by the document's ID, you can use the ## Indexing Missing Fields By default, indexes will not index a document that contains none of the specified fields. This behavior can be changed -using the [Indexing.IndexEmptyEntries](../server/configuration/indexing-configuration.mdx#indexing.indexemptyentries) +using the [Indexing.IndexEmptyEntries](../server/configuration/indexing-configuration.mdx#indexingindexemptyentries) configuration option. -The option [Indexing.IndexMissingFieldsAsNull](../server/configuration/indexing-configuration.mdx#indexing.indexmissingfieldsasnull) +The option [Indexing.IndexMissingFieldsAsNull](../server/configuration/indexing-configuration.mdx#indexingindexmissingfieldsasnull) determines whether missing fields in documents are indexed with the value `null`, or not indexed at all. diff --git a/docs/indexes/querying/exploration-queries.mdx b/docs/indexes/querying/exploration-queries.mdx index 645515e86c..540fbb6b9c 100644 --- a/docs/indexes/querying/exploration-queries.mdx +++ b/docs/indexes/querying/exploration-queries.mdx @@ -22,9 +22,9 @@ export const supportedLanguages = ["csharp", "python", "php", "nodejs"]; * **Exploration Queries** form an additional layer of filtering that can be applied - to a dataset after its retrieval by [Query](../../client-api/session/querying/how-to-query.mdx#session.query), - [DocumentQuery](../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery), - or [Raw RQL](../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery), + to a dataset after its retrieval by [Query](../../client-api/session/querying/how-to-query.mdx#sessionquery), + [DocumentQuery](../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery), + or [Raw RQL](../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery), while the dataset is still held by the server. * The **retrieved dataset** is scanned and filtered **without requiring or creating an @@ -347,7 +347,7 @@ filter_limit 100 * **Exploration Queries** form an additional layer of filtering that can be applied - to a dataset after its retrieval by [raw_rql](../../client-api/session/querying/how-to-query.mdx#session.advanced.raw_query), + to a dataset after its retrieval by [raw_rql](../../client-api/session/querying/how-to-query.mdx#sessionadvancedraw_query), while the dataset is still held by the server. * The **retrieved dataset** is scanned and filtered **without requiring or creating an @@ -578,7 +578,7 @@ filter_limit 100 * **Exploration Queries** form an additional layer of filtering that can be applied - to a dataset after its retrieval by [raw rql](../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery), + to a dataset after its retrieval by [raw rql](../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery), while the dataset is still held by the server. * The **retrieved dataset** is scanned and filtered **without requiring or creating an @@ -864,8 +864,8 @@ filter_limit 100 * **Exploration Queries** form an additional layer of filtering that can be applied - to a dataset after its retrieval by [query](../../client-api/session/querying/how-to-query.mdx#session.query), - or [rawQuery](../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery), + to a dataset after its retrieval by [query](../../client-api/session/querying/how-to-query.mdx#sessionquery), + or [rawQuery](../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery), while the dataset is still held by the server. * The **retrieved dataset** is scanned and filtered **without requiring or creating an index**, diff --git a/docs/indexes/querying/paging.mdx b/docs/indexes/querying/paging.mdx index c9894715ea..a7bc0a42b6 100644 --- a/docs/indexes/querying/paging.mdx +++ b/docs/indexes/querying/paging.mdx @@ -406,7 +406,7 @@ This practice has several benefits: * By default, if the number of returned results exceeds **2048**, the server will issue a "Page size too big" notification (visible in the Studio) with information about the query. -* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehints.maxnumberofresults) configuration key. +* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehintsmaxnumberofresults) configuration key. * As suggested by the hint, you may consider using [Streaming query results](../../client-api/session/querying/how-to-stream-query-results.mdx) instead of paging. @@ -967,7 +967,7 @@ This practice has several benefits: * By default, if the number of returned results exceeds **2048**, the server will issue a "Page size too big" notification (visible in the Studio) with information about the query. -* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehints.maxnumberofresults) configuration key. +* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehintsmaxnumberofresults) configuration key. * As suggested by the hint, you may consider using [Streaming query results](../../client-api/session/querying/how-to-stream-query-results.mdx) instead of paging. @@ -1336,7 +1336,7 @@ This practice has several benefits: * By default, if the number of returned results exceeds **2048**, the server will issue a "Page size too big" notification (visible in the Studio) with information about the query. -* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehints.maxnumberofresults) configuration key. +* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehintsmaxnumberofresults) configuration key. * As suggested by this performance hint, you may consider using [Streaming query results](../../client-api/session/querying/how-to-stream-query-results.mdx) instead of paging. @@ -1884,7 +1884,7 @@ This practice has several benefits: * By default, if the number of returned results exceeds **2048**, the server will issue a "Page size too big" notification (visible in the Studio) with information about the query. -* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehints.maxnumberofresults) configuration key. +* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehintsmaxnumberofresults) configuration key. * As suggested by this performance hint, you may consider using [Streaming query results](../../client-api/session/querying/how-to-stream-query-results.mdx) instead of paging. @@ -2430,7 +2430,7 @@ This practice has several benefits: * By default, if the number of returned results exceeds **2048**, the server will issue a "Page size too big" notification (visible in the Studio) with information about the query. -* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehints.maxnumberofresults) configuration key. +* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehintsmaxnumberofresults) configuration key. * As suggested by the hint, you may consider using [Streaming query results](../../client-api/session/querying/how-to-stream-query-results.mdx) instead of paging. diff --git a/docs/indexes/querying/query-index.mdx b/docs/indexes/querying/query-index.mdx index 09c678c5af..71f4378142 100644 --- a/docs/indexes/querying/query-index.mdx +++ b/docs/indexes/querying/query-index.mdx @@ -478,8 +478,8 @@ where LastName == "King" ## Query an index by `RawQuery` -* Queries defined with [Query](../../indexes/querying/query-index.mdx#session.query) - or [DocumentQuery](../../indexes/querying/query-index.mdx#session.advanced.documentquery) +* Queries defined with [Query](../../indexes/querying/query-index.mdx#sessionquery) + or [DocumentQuery](../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) are translated by the RavenDB client to [RQL](../../client-api/session/querying/what-is-rql.mdx) when sent to the server. @@ -1007,8 +1007,8 @@ limit 5, 10 // skip 5, take 10 ## Query an index by `raw_query` -* Queries defined with [Query](../../indexes/querying/query-index.mdx#session.query) - or [DocumentQuery](../../indexes/querying/query-index.mdx#session.advanced.documentquery) +* Queries defined with [Query](../../indexes/querying/query-index.mdx#sessionquery) + or [DocumentQuery](../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) are translated by the RavenDB client to [RQL](../../client-api/session/querying/what-is-rql.mdx) when sent to the server. @@ -1520,8 +1520,8 @@ where LastName == "King" ## Query an index by `rawQuery` -* Queries defined with [Query](../../indexes/querying/query-index.mdx#session.query) - or [DocumentQuery](../../indexes/querying/query-index.mdx#session.advanced.documentquery) +* Queries defined with [Query](../../indexes/querying/query-index.mdx#sessionquery) + or [DocumentQuery](../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) are translated by the RavenDB client to [RQL](../../client-api/session/querying/what-is-rql.mdx) when sent to the server. @@ -1890,7 +1890,7 @@ limit 5, 10 // skip 5, take 10 ## Query an index by `RawQuery` -* Queries defined with [query](../../indexes/querying/query-index.mdx#session.query) 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](../../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. * The session also gives you a way to express the query directly in RQL using the `rawQuery` method. diff --git a/docs/indexes/rolling-index-deployment.mdx b/docs/indexes/rolling-index-deployment.mdx index 907fb4f1c1..dd67018bd6 100644 --- a/docs/indexes/rolling-index-deployment.mdx +++ b/docs/indexes/rolling-index-deployment.mdx @@ -89,7 +89,7 @@ Nodes are assigned with the indexing of each database in a linear order, one nod ## Setting Indexing Deployment Mode ### Server-Wide Deployment Mode - Deployment mode can be set server-wide using [configuration options](../server/configuration/configuration-options.mdx#settings.json). + Deployment mode can be set server-wide using [configuration options](../server/configuration/configuration-options.mdx#settingsjson). Setting the server-wide configuration option will apply to all databases on a given node. * [Auto Indexes](../indexes/creating-and-deploying.mdx#auto-indexes) Deployment Mode diff --git a/docs/indexes/search-engine/corax.mdx b/docs/indexes/search-engine/corax.mdx index 0dfd99ec01..b13bca68df 100644 --- a/docs/indexes/search-engine/corax.mdx +++ b/docs/indexes/search-engine/corax.mdx @@ -63,17 +63,17 @@ import LanguageContent from "@site/src/components/LanguageContent"; * These configuration options are available: - * [Indexing.Auto.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexing.auto.searchenginetype) + * [Indexing.Auto.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexingautosearchenginetype) Use this option to select the search engine (either `Lucene` or `Corax`) for **auto** indexes. The search engine can be selected **server-wide** or **per database**. - * [Indexing.Static.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexing.static.searchenginetype) + * [Indexing.Static.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexingstaticsearchenginetype) Use this option to select the search engine (either `Lucene` or `Corax`) for **static** indexes. The search engine can be selected **server-wide**, **per database**, or **per index**. * Read about additional Corax configuration options [here](../../indexes/search-engine/corax.mdx#configuration-options). ### Select search engine: Server wide Select the search engine for all the databases hosted by a server -by modifying the server's [settings.json](../../server/configuration/configuration-options.mdx#settings.json) file. +by modifying the server's [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) file. E.g. - @@ -397,7 +397,7 @@ a static index. * **New static index** (created or reset on RavenDB `6.2.x` and on) The index will behave as determined by the - [Indexing.Corax.Static.ComplexFieldIndexingBehavior](../../server/configuration/indexing-configuration.mdx#indexing.corax.static.complexfieldindexingbehavior) + [Indexing.Corax.Static.ComplexFieldIndexingBehavior](../../server/configuration/indexing-configuration.mdx#indexingcoraxstaticcomplexfieldindexingbehavior) configuration option. * If `ComplexFieldIndexingBehavior` is set to **`Throw`** - Corax will throw a `NotSupportedInCoraxException` exception with this message: @@ -519,39 +519,39 @@ order by Location Corax configuration options include: -* [Indexing.Auto.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexing.auto.searchenginetype) +* [Indexing.Auto.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexingautosearchenginetype) [Select](../../indexes/search-engine/corax.mdx#selecting-the-search-engine) the search engine for **Auto** indexes. -* [Indexing.Static.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexing.static.searchenginetype) +* [Indexing.Static.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexingstaticsearchenginetype) [Select](../../indexes/search-engine/corax.mdx#selecting-the-search-engine) the search engine for **Static** indexes. -* [Indexing.Corax.IncludeDocumentScore](../../server/configuration/indexing-configuration.mdx#indexing.corax.includedocumentscore) +* [Indexing.Corax.IncludeDocumentScore](../../server/configuration/indexing-configuration.mdx#indexingcoraxincludedocumentscore) Choose whether to include the score value in document metadata when sorting by score. Disabling this option can improve query performance. -* [Indexing.Corax.IncludeSpatialDistance](../../server/configuration/indexing-configuration.mdx#indexing.corax.includespatialdistance) +* [Indexing.Corax.IncludeSpatialDistance](../../server/configuration/indexing-configuration.mdx#indexingcoraxincludespatialdistance) Choose whether to include spatial information in document metadata when sorting by distance. Disabling this option can improve query performance. -* [Indexing.Corax.MaxMemoizationSizeInMb](../../server/configuration/indexing-configuration.mdx#indexing.corax.maxmemoizationsizeinmb) +* [Indexing.Corax.MaxMemoizationSizeInMb](../../server/configuration/indexing-configuration.mdx#indexingcoraxmaxmemoizationsizeinmb) The maximum amount of memory that Corax can use for a memoization clause during query processing. Please configure this option only if you are an expert. -* [Indexing.Corax.DocumentsLimitForCompressionDictionaryCreation](../../server/configuration/indexing-configuration.mdx#indexing.corax.documentslimitforcompressiondictionarycreation) +* [Indexing.Corax.DocumentsLimitForCompressionDictionaryCreation](../../server/configuration/indexing-configuration.mdx#indexingcoraxdocumentslimitforcompressiondictionarycreation) Set the maximum number of documents that will be used for the training of a Corax index during dictionary creation. Training will stop when it reaches this limit. -* [Indexing.Corax.MaxAllocationsAtDictionaryTrainingInMb](../../server/configuration/indexing-configuration.mdx#indexing.corax.maxallocationsatdictionarytraininginmb) +* [Indexing.Corax.MaxAllocationsAtDictionaryTrainingInMb](../../server/configuration/indexing-configuration.mdx#indexingcoraxmaxallocationsatdictionarytraininginmb) Set the maximum amount of memory (in MB) that will be allocated for the training of a Corax index during dictionary creation. Training will stop when it reaches this limit. -* [Indexing.Corax.Static.ComplexFieldIndexingBehavior](../../server/configuration/indexing-configuration.mdx#indexing.corax.static.complexfieldindexingbehavior) +* [Indexing.Corax.Static.ComplexFieldIndexingBehavior](../../server/configuration/indexing-configuration.mdx#indexingcoraxstaticcomplexfieldindexingbehavior) Choose [how to react](../../indexes/search-engine/corax.mdx#if-corax-encounters-a-complex-property-while-indexing) when a static Corax index is requested to index a complex JSON object. @@ -578,14 +578,14 @@ Here are some additional things to keep in mind about Corax indexes compression * The benefits of compression dictionaries are most pronounced for large collections. Training stops when it reaches either the - [number of documents](../../server/configuration/indexing-configuration.mdx#indexing.corax.documentslimitforcompressiondictionarycreation) + [number of documents](../../server/configuration/indexing-configuration.mdx#indexingcoraxdocumentslimitforcompressiondictionarycreation) threshold (100,000 docs by default) or the - [amount of memory](../../server/configuration/indexing-configuration.mdx#indexing.corax.maxallocationsatdictionarytraininginmb) + [amount of memory](../../server/configuration/indexing-configuration.mdx#indexingcoraxmaxallocationsatdictionarytraininginmb) threshold (up to 2GB). Both thresholds are configurable. * If upon creation there are less than 10,000 documents in the involved collections, it may make sense to manually force an index reset after reaching - [100,000](../../server/configuration/indexing-configuration.mdx#indexing.corax.documentslimitforcompressiondictionarycreation) + [100,000](../../server/configuration/indexing-configuration.mdx#indexingcoraxdocumentslimitforcompressiondictionarycreation) documents to force retraining. Indexes are replaced in a [side-by-side](../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---side-by-side-indexing) diff --git a/docs/indexes/using-analyzers.mdx b/docs/indexes/using-analyzers.mdx index 326691a899..bbfd4038e1 100644 --- a/docs/indexes/using-analyzers.mdx +++ b/docs/indexes/using-analyzers.mdx @@ -281,7 +281,7 @@ There are two exceptions to this rule: 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: - * Increase the [MaxGram](../server/configuration/indexing-configuration.mdx#indexing.lucene.analyzers.ngram.maxgram) value to generate larger tokens during indexing (when using Lucene). + * Increase the [MaxGram](../server/configuration/indexing-configuration.mdx#indexingluceneanalyzersngrammaxgram) value to generate larger tokens during indexing (when using Lucene). * Use a different analyzer other than _NGramAnalyzer_ that better matches your requirements. 2. Behavior is also different when making a full-text search with wildcards in the search terms. @@ -459,8 +459,8 @@ All examples below use the following text: * **Overriding default token length**: (only when using Lucene as the search engine) You can override the default token lengths of the NGram analyzer by setting the following configuration keys: - [Indexing.Lucene.Analyzers.NGram.MinGram](../server/configuration/indexing-configuration.mdx#indexing.lucene.analyzers.ngram.mingram) - and [Indexing.Lucene.Analyzers.NGram.MaxGram](../server/configuration/indexing-configuration.mdx#indexing.lucene.analyzers.ngram.maxgram). + [Indexing.Lucene.Analyzers.NGram.MinGram](../server/configuration/indexing-configuration.mdx#indexingluceneanalyzersngrammingram) + and [Indexing.Lucene.Analyzers.NGram.MaxGram](../server/configuration/indexing-configuration.mdx#indexingluceneanalyzersngrammaxgram). For example, setting them to 3 and 4, respectively, will generate the following tokens: @@ -577,7 +577,7 @@ store.Maintenance.Send(new PutIndexesOperation(indexDefinition)); By default, this analyzer is the `RavenStandardAnalyzer` (inherits from Lucene's _StandardAnalyzer_). * To customize a different analyzer that will serve as your Default Search Analyzer, - set the [Indexing.Analyzers.Search.Default](../server/configuration/indexing-configuration.mdx#indexing.analyzers.search.default) configuration key. + set the [Indexing.Analyzers.Search.Default](../server/configuration/indexing-configuration.mdx#indexinganalyzerssearchdefault) configuration key. * Using a search analyzer enables full-text search queries against the field. Given the same sample text from above, _RavenStandardAnalyzer_ will produce the following tokens: @@ -623,7 +623,7 @@ store.Maintenance.Send(new PutIndexesOperation(indexDefinition)); The field's value is indexed exactly as provided, enabling precise, case-sensitive matching at query time. * To customize a different analyzer that will serve as your Default Exact Analyzer, - set the [Indexing.Analyzers.Exact.Default ](../server/configuration/indexing-configuration.mdx#indexing.analyzers.exact.default) configuration key. + set the [Indexing.Analyzers.Exact.Default ](../server/configuration/indexing-configuration.mdx#indexinganalyzersexactdefault) configuration key. * Given the same sample text from above, _KeywordAnalyzer_ will produce a single token: `[The quick brown fox jumped over the lazy dogs, Bob@hotmail.com 123432.]` @@ -666,7 +666,7 @@ store.Maintenance.Send(new PutIndexesOperation(indexDefinition)); The entire content of the field is processed into a single, lowercased token. * To customize a different analyzer that will serve as your Default Analyzer, - set the [Indexing.Analyzers.Default](../server/configuration/indexing-configuration.mdx#indexing.analyzers.default) configuration key. + set the [Indexing.Analyzers.Default](../server/configuration/indexing-configuration.mdx#indexinganalyzersdefault) configuration key. * Given the same sample text from above, _LowerCaseKeywordAnalyzer_ will produce a single token: `[the quick brown fox jumped over the lazy dogs, bob@hotmail.com 123432.]` @@ -970,7 +970,7 @@ There are two exceptions to this rule: 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: - * Increase the [MaxGram](../server/configuration/indexing-configuration.mdx#indexing.lucene.analyzers.ngram.maxgram) value to generate larger tokens during indexing (when using Lucene). + * Increase the [MaxGram](../server/configuration/indexing-configuration.mdx#indexingluceneanalyzersngrammaxgram) value to generate larger tokens during indexing (when using Lucene). * Use a different analyzer other than _NGramAnalyzer_ that better matches your requirements. 2. Behavior is also different when making a full-text search with wildcards in the search terms. @@ -1148,8 +1148,8 @@ All examples below use the following text: * **Overriding default token length**: (only when using Lucene as the search engine) You can override the default token lengths of the NGram analyzer by setting the following configuration keys: - [Indexing.Lucene.Analyzers.NGram.MinGram](../server/configuration/indexing-configuration.mdx#indexing.lucene.analyzers.ngram.mingram) - and [Indexing.Lucene.Analyzers.NGram.MaxGram](../server/configuration/indexing-configuration.mdx#indexing.lucene.analyzers.ngram.maxgram). + [Indexing.Lucene.Analyzers.NGram.MinGram](../server/configuration/indexing-configuration.mdx#indexingluceneanalyzersngrammingram) + and [Indexing.Lucene.Analyzers.NGram.MaxGram](../server/configuration/indexing-configuration.mdx#indexingluceneanalyzersngrammaxgram). For example, setting them to 3 and 4, respectively, will generate the following tokens: @@ -1250,7 +1250,7 @@ await store.maintenance By default, this analyzer is the `RavenStandardAnalyzer` (inherits from Lucene's _StandardAnalyzer_). * To customize a different analyzer that will serve as your Default Search Analyzer, - set the [Indexing.Analyzers.Search.Default](../server/configuration/indexing-configuration.mdx#indexing.analyzers.search.default) configuration key. + set the [Indexing.Analyzers.Search.Default](../server/configuration/indexing-configuration.mdx#indexinganalyzerssearchdefault) configuration key. * Using a search analyzer enables full-text search queries against the field. Given the same sample text from above, _RavenStandardAnalyzer_ will produce the following tokens: @@ -1293,7 +1293,7 @@ await store.maintenance The field's value is indexed exactly as provided, enabling precise, case-sensitive matching at query time. * To customize a different analyzer that will serve as your Default Exact Analyzer, - set the [Indexing.Analyzers.Exact.Default ](../server/configuration/indexing-configuration.mdx#indexing.analyzers.exact.default) configuration key. + set the [Indexing.Analyzers.Exact.Default ](../server/configuration/indexing-configuration.mdx#indexinganalyzersexactdefault) configuration key. * Given the same sample text from above, _KeywordAnalyzer_ will produce a single token: `[The quick brown fox jumped over the lazy dogs, Bob@hotmail.com 123432.]` @@ -1334,7 +1334,7 @@ await store.maintenance The entire content of the field is processed into a single, lowercased token. * To customize a different analyzer that will serve as your Default Analyzer, - set the [Indexing.Analyzers.Default](../server/configuration/indexing-configuration.mdx#indexing.analyzers.default) configuration key. + set the [Indexing.Analyzers.Default](../server/configuration/indexing-configuration.mdx#indexinganalyzersdefault) configuration key. * Given the same sample text from above, _LowerCaseKeywordAnalyzer_ will produce a single token: `[the quick brown fox jumped over the lazy dogs, bob@hotmail.com 123432.]` 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 fe4176cb57..55b371bccc 100644 --- a/docs/integrations/akka.net-persistence/integrating-with-akka-persistence.mdx +++ b/docs/integrations/akka.net-persistence/integrating-with-akka-persistence.mdx @@ -19,7 +19,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * 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#akka.persistence.ravendb) + * [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) diff --git a/docs/integrations/postgresql-protocol/overview.mdx b/docs/integrations/postgresql-protocol/overview.mdx index c00f9cd25f..a5402e201a 100644 --- a/docs/integrations/postgresql-protocol/overview.mdx +++ b/docs/integrations/postgresql-protocol/overview.mdx @@ -47,7 +47,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; If your current license doesn't include Power BI Support, you can acquire one that does [here](https://ravendb.net/buy). ### Settings -* PostgreSQL protocol support must be explicitly enabled in your [settings](../../server/configuration/configuration-options.mdx#settings.json). +* PostgreSQL protocol support must be explicitly enabled in your [settings](../../server/configuration/configuration-options.mdx#settingsjson). Add this line to your server's `settings.json` file to enable the PostgreSQL protocol: @@ -56,7 +56,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * PostgreSQL is an experimental feature. To enable it, enable RavenDB's - [Experimental Features](../../server/configuration/core-configuration.mdx#features.availability) + [Experimental Features](../../server/configuration/core-configuration.mdx#featuresavailability) by adding this line to your server's `settings.json` file: diff --git a/docs/migration/client-api/client-breaking-changes.mdx b/docs/migration/client-api/client-breaking-changes.mdx index beeda62249..def25146f6 100644 --- a/docs/migration/client-api/client-breaking-changes.mdx +++ b/docs/migration/client-api/client-breaking-changes.mdx @@ -118,7 +118,7 @@ Clients can switch to a different HTTP-Compression algorithm using `DocumentStor If you migrate from an earlier RavenDB version to version `7.0` or higher, -please note the [potential significance of this change](../../migration/client-api/client-migration.mdx#client-migration-to-ravendb-7.x). +please note the [potential significance of this change](../../migration/client-api/client-migration.mdx#client-migration-to-ravendb-7x). diff --git a/docs/migration/client-api/client-migration.mdx b/docs/migration/client-api/client-migration.mdx index 08e0b446bf..896d925074 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 page: - * [Client migration to RavenDB `7.x`](../../migration/client-api/client-migration.mdx#client-migration-to-ravendb-7.x) + * [Client migration to RavenDB `7.x`](../../migration/client-api/client-migration.mdx#client-migration-to-ravendb-7x) ## Client migration to RavenDB `7.x` diff --git a/docs/migration/server/data-migration.mdx b/docs/migration/server/data-migration.mdx index 2ef5da0380..0535185fc9 100644 --- a/docs/migration/server/data-migration.mdx +++ b/docs/migration/server/data-migration.mdx @@ -16,10 +16,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Migration to RavenDB `7.x`](../../migration/server/data-migration.mdx#migration-to-ravendb-7.x) - * [Migration from RavenDB 5.x to 6.x](../../migration/server/data-migration.mdx#migration-from-ravendb-5.x-to-6.x) - * [Migration from RavenDB 4.x to RavenDB 5.x and 6.x](../../migration/server/data-migration.mdx#migration-from-ravendb-4.x-to-ravendb-5.x-and-6.x) - * [Migration from RavenDB 3.x](../../migration/server/data-migration.mdx#migration-from-ravendb-3.x) + * [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) @@ -66,7 +66,7 @@ Earlier versions used `Gzip`. * RavenDB `6.x` supports in-place data migration from RavenDB `5.x`. * RavenDB `5.x` product licenses **do not apply** to RavenDB `6.x`. To upgrade a valid `5.x` license to a RavenDB `6.x` license, - please use the **License upgrade tool** [as explained here](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6.x). + please use the **License upgrade tool** [as explained here](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6x). Please note that once upgraded, RavenDB `6.x` cannot be downgraded to version `5.x`, @@ -86,7 +86,7 @@ and the migrated data will no longer be accessible via RavenDB `5.x`. * RavenDB `4.x` product licenses **do not apply** to RavenDB `6.x`. To upgrade a valid `4.x` license to a RavenDB `6.x` license, - please use the **License upgrade tool** [as explained here](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6.x). + please use the **License upgrade tool** [as explained here](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6x). Please note that once upgraded, RavenDB `6.x` cannot be downgraded to version `4.x`, diff --git a/docs/migration/server/docker.mdx b/docs/migration/server/docker.mdx index ce699c3d4f..71f5b23e88 100644 --- a/docs/migration/server/docker.mdx +++ b/docs/migration/server/docker.mdx @@ -26,8 +26,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Read [here](../../start/containers/image-usage.mdx) more about running a RavenDB Docker image. * In this page: - * [Changes Made In RavenDB `6.0` And Up](../../migration/server/docker.mdx#changes-made-in-ravendb-6.0-and-up) - * [Migrating To `6.0` And Up](../../migration/server/docker.mdx#migrating-to-6.0-and-up) + * [Changes Made In RavenDB `6.0` And Up](../../migration/server/docker.mdx#changes-made-in-ravendb-60-and-up) + * [Migrating To `6.0` And Up](../../migration/server/docker.mdx#migrating-to-60-and-up) ## Changes Made In RavenDB 6.0 And Up diff --git a/docs/server/administration/cli.mdx b/docs/server/administration/cli.mdx index 9bde4dea0c..49db6354b4 100644 --- a/docs/server/administration/cli.mdx +++ b/docs/server/administration/cli.mdx @@ -119,7 +119,7 @@ Enable (or disable) online log printing to the console. | Parameters | Description | | ------------- | ------------- | | `http-on` or `http-off` | Enables or disables HTTP requests log information | -| `info`, `debug` | Sets logging to the requested [level](../../server/configuration/logs-configuration.mdx#logs.minlevel) | +| `info`, `debug` | Sets logging to the requested [level](../../server/configuration/logs-configuration.mdx#logsminlevel) | | `on` or `off` | Enables or disables log printing | | `no-console` | Disables logging to console | diff --git a/docs/server/administration/monitoring/open-telemetry.mdx b/docs/server/administration/monitoring/open-telemetry.mdx index 3e89269403..8aae6d4505 100644 --- a/docs/server/administration/monitoring/open-telemetry.mdx +++ b/docs/server/administration/monitoring/open-telemetry.mdx @@ -43,7 +43,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ## Enabling OpenTelemetry in RavenDB * To enable the OpenTelemetry metrics in RavenDB, - you **must** first set the [Monitoring.OpenTelemetry.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.enabled) configuration key to _true_. + you **must** first set the [Monitoring.OpenTelemetry.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryenabled) configuration key to _true_. * Learn how to customize configuration keys in the [Configuration Overview](../../../server/configuration/configuration-options.mdx) article, which outlines all available options. @@ -65,41 +65,41 @@ RavenDB exposes the following meters: * **ravendb.server.cpucredits** Description: Exposes status of CPU credits (cloud) Enabled by default: _false_ - Configuration key: [Monitoring.OpenTelemetry.Meters.Server.CPUCredits.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.cpucredits.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.Server.CPUCredits.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersservercpucreditsenabled) * **ravendb.server.gc** Description: Exposes detailed information about the Garbage Collector Enabled by default: _false_ - Configuration key: [Monitoring.OpenTelemetry.Meters.Server.GC.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.gc.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.Server.GC.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersservergcenabled) * **ravendb.server.general** Description: Exposes general info about the cluster and its licensing Enabled by default: _true_ - Configuration key: [Monitoring.OpenTelemetry.Meters.Server.General.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.general.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.Server.General.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersservergeneralenabled) * **ravendb.server.requests** Description: Exposes information about requests processed by server Enabled by default: _true_ - Configuration key: [Monitoring.OpenTelemetry.Meters.Server.Requests.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.requests.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.Server.Requests.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersserverrequestsenabled) * **ravendb.server.resources** Description: Exposes detailed information about resources usage (e.g. CPU etc.) Enabled by default: _true_ - Configuration key: [Monitoring.OpenTelemetry.Meters.Server.Resources.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.resources.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.Server.Resources.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersserverresourcesenabled) * **ravendb.server.storage** Description: Exposes storage information Enabled by default: _true_ - Configuration key: [Monitoring.OpenTelemetry.Meters.Server.Storage.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.storage.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.Server.Storage.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersserverstorageenabled) * **ravendb.server.totaldatabases** Description: Exposes aggregated information about databases on the server Enabled by default: _true_ - Configuration key: [Monitoring.OpenTelemetry.Meters.Server.TotalDatabases.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.totaldatabases.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.Server.TotalDatabases.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersservertotaldatabasesenabled) RavenDB also supports exposing meters developed by Microsoft for AspNetCore and .NET Runtime: * **Official AspNetCore instrumentation** Description: See the official MS documentation [AspNetCore documentation](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/main/src/OpenTelemetry.Instrumentation.AspNetCore/README.md#metrics) Enabled by default: _false_ - Configuration key: [Monitoring.OpenTelemetry.Meters.AspNetCore.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.aspnetcore.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.AspNetCore.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersaspnetcoreenabled) * **Official Runtime instrumentation** Description: See the official MS documentation [.NET Runtime documentation](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/tree/main/src/OpenTelemetry.Instrumentation.Runtime#metrics) Enabled by default: _false_ - Configuration key: [Monitoring.OpenTelemetry.Meters.Runtime.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.runtime.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.Runtime.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersruntimeenabled) @@ -112,7 +112,7 @@ RavenDB also supports exposing meters developed by Microsoft for AspNetCore and * The server instance identification is determined by the following sequence: 1. **Configuration Key** - First, attempt to retrieve the [Monitoring.OpenTelemetry.ServiceInstanceId](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.serviceinstanceid) configuration key. + First, attempt to retrieve the [Monitoring.OpenTelemetry.ServiceInstanceId](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryserviceinstanceid) configuration key. 2. **Public URL Hostname** If the configuration key is Not defined, use the server's public URL hostname, provided it is available. 3. **Node Tag** @@ -257,7 +257,7 @@ RavenDB offers two options for exporting metrics: as it eliminates the need for integration with external monitoring systems or observability platforms. * To enable output to the console - - set the [Monitoring.OpenTelemetry.ConsoleExporter](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.consoleexporter) configuration key to _true_. + set the [Monitoring.OpenTelemetry.ConsoleExporter](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryconsoleexporter) configuration key to _true_. @@ -274,18 +274,18 @@ RavenDB offers two options for exporting metrics: * RavenDB supports the official OTLP by default, allowing you to export RavenDB metrics to the OpenTelemetry Collector. * To enable exporting metrics via the OpenTelemetry Protocol - - set the [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.enabled) configuration key to _true_. + set the [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolenabled) configuration key to _true_. * By default, RavenDB does not override the OpenTelemetry Protocol exporter default values. However, customization is available via the following configuration options: | Configuration key | Description | Accepted values | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| -| Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.ExportProcessorType](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.exportprocessortype) | Export processor type | Simple / Batch | -| Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Headers](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.headers) | Custom headers | string | -| Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Protocol](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.protocol) | Defines the transport protocol that OpenTelemetry Protocol should use to send data. | gRPC / HttpProtobuf | -| Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Endpoint](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.endpoint) | Endpoint where OpenTelemetry Protocol should send data.
See configuration details [below](../../../server/administration/monitoring/open-telemetry.mdx#configure-endpoint). | string | -| Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Timeout](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.timeout) | Timeout | int | +| 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
[.Timeout](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocoltimeout) | Timeout | int | diff --git a/docs/server/administration/snmp/snmp-overview.mdx b/docs/server/administration/snmp/snmp-overview.mdx index 84621a9a7a..804007342b 100644 --- a/docs/server/administration/snmp/snmp-overview.mdx +++ b/docs/server/administration/snmp/snmp-overview.mdx @@ -63,7 +63,7 @@ SNMP support is available for [Enterprise](../../../start/licensing/licensing-ov ## Enabling SNMP in RavenDB -* To monitor RavenDB using SNMP you __must__ first set the [Monitoring.Snmp.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.enabled) configuration key to _true_. +* To monitor RavenDB using SNMP you __must__ first set the [Monitoring.Snmp.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpenabled) configuration key to _true_. * To learn how to modify a configuration key, refer to the [Configuration Overview](../../../server/configuration/configuration-options.mdx) article, which outlines all available options. @@ -88,36 +88,36 @@ SNMP support is available for [Enterprise](../../../start/licensing/licensing-ov There are several configurable SNMP properties in RavenDB: ##### For SNMPv1: -* [Monitoring.Snmp.Port](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.port) +* [Monitoring.Snmp.Port](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpport) The SNMP port. Default: `161` -* [Monitoring.Snmp.SupportedVersions](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.supportedversions) +* [Monitoring.Snmp.SupportedVersions](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpsupportedversions) List of supported SNMP versions. Default: `"V2C;V3"` ##### For SNMPv2c: -* [Monitoring.Snmp.Community](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.community) +* [Monitoring.Snmp.Community](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpcommunity) The community string is used as a password. It is sent with each SNMP `GET` request and allows or denies access to the monitored device. Default: `"ravendb"` ##### For SNMPv3: -* [Monitoring.Snmp.AuthenticationProtocol](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationprotocol) +* [Monitoring.Snmp.AuthenticationProtocol](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationprotocol) Authentication protocol. Default: `"SHA1"` -* [Monitoring.Snmp.AuthenticationUser](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationuser) +* [Monitoring.Snmp.AuthenticationUser](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationuser) The user for authentication. Default: `"ravendb"` -* [Monitoring.Snmp.AuthenticationPassword](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationpassword) +* [Monitoring.Snmp.AuthenticationPassword](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationpassword) The authentication password. When set to `null` the community string is used instead. Default: `null` -* [Monitoring.Snmp.PrivacyProtocol](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.privacyprotocol) +* [Monitoring.Snmp.PrivacyProtocol](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpprivacyprotocol) Privacy protocol. Default: `None` -* [Monitoring.Snmp.PrivacyPassword](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.privacypassword) +* [Monitoring.Snmp.PrivacyPassword](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpprivacypassword) Privacy password. Default: `"ravendb"` @@ -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#1.3). + 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 SNMPv2c: @@ -166,7 +166,7 @@ iso.3.6.1.4.1.45751.1.1.1.3 = Timeticks: (29543973) 3 days, 10:03:59.73 - * `ravendb` is the community string (set via the [Monitoring.Snmp.Community](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.community) configuration key). + * `ravendb` is the community string (set via the [Monitoring.Snmp.Community](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpcommunity) configuration key). * `"live-test.ravendb.net"` is the host. ##### For SNMPv3: @@ -195,7 +195,7 @@ __Access single OID value__: * 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#1.3): +* For example, a cURL request for the server [up-time metric](../../../server/administration/snmp/snmp-overview.mdx#13): @@ -212,7 +212,7 @@ __Access multiple OID values__: * 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#1.6.7) and [unmanaged memory](../../../server/administration/snmp/snmp-overview.mdx#1.6.8) metrics: +* 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: diff --git a/docs/server/clustering/distribution/cluster-observer.mdx b/docs/server/clustering/distribution/cluster-observer.mdx index 682ee0755e..44d14439b6 100644 --- a/docs/server/clustering/distribution/cluster-observer.mdx +++ b/docs/server/clustering/distribution/cluster-observer.mdx @@ -30,8 +30,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * To maintain the Replication Factor, every newly elected [Leader](../../../server/clustering/rachis/cluster-topology.mdx#leader) starts measuring the health of each node by creating dedicated maintenance TCP connections to all other nodes in the cluster. -* Each node reports the current status of _all_ its databases at intervals of [500 milliseconds](../../../server/configuration/cluster-configuration.mdx#cluster.workersampleperiodinms) (by default). - The `Cluster Observer` consumes those reports every [1000 milliseconds](../../../server/configuration/cluster-configuration.mdx#cluster.supervisorsampleperiodinms) (by default). +* Each node reports the current status of _all_ its databases at intervals of [500 milliseconds](../../../server/configuration/cluster-configuration.mdx#clusterworkersampleperiodinms) (by default). + The `Cluster Observer` consumes those reports every [1000 milliseconds](../../../server/configuration/cluster-configuration.mdx#clustersupervisorsampleperiodinms) (by default). * Upon a **node failure**, the [Dynamic Database Distribution](../../../server/clustering/distribution/distributed-database.mdx#dynamic-database-distribution) sequence will take place in order to ensure that the `Replication Factor` does not change. @@ -49,11 +49,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * If node C goes offline or becomes unreachable, the Cluster Observer detects the issue. Initially: - * After the duration specified in the [Cluster.TimeBeforeMovingToRehabInSec](../../../server/configuration/cluster-configuration.mdx#cluster.timebeforemovingtorehabinsec) configuration, + * After the duration specified in the [Cluster.TimeBeforeMovingToRehabInSec](../../../server/configuration/cluster-configuration.mdx#clustertimebeforemovingtorehabinsec) configuration, the observer moves node C to rehab mode, allowing time for recovery. * The ETL task fails over to another available node in the Database Group. - * If node C remains offline beyond the period specified in the [Cluster.TimeBeforeAddingReplicaInSec](../../../server/configuration/cluster-configuration.mdx#cluster.timebeforeaddingreplicainsec) configuration, + * If node C remains offline beyond the period specified in the [Cluster.TimeBeforeAddingReplicaInSec](../../../server/configuration/cluster-configuration.mdx#clustertimebeforeaddingreplicainsec) configuration, the observer begins replicating the database to another node in the Database Group as a last resort. diff --git a/docs/server/clustering/distribution/distributed-database.mdx b/docs/server/clustering/distribution/distributed-database.mdx index 527c60e3d8..bb6aeb9415 100644 --- a/docs/server/clustering/distribution/distributed-database.mdx +++ b/docs/server/clustering/distribution/distributed-database.mdx @@ -101,10 +101,10 @@ All `Members` have master-master [Replication](../../../server/clustering/replic If any of the `Database Nodes` is down or partitioned, the [Cluster Observer](../../../server/clustering/distribution/cluster-observer.mdx) will recognize it and act as follows: -1. If the time that is defined in [TimeBeforeMovingToRehabInSec](../../../server/configuration/cluster-configuration.mdx#cluster.timebeforemovingtorehabinsec) (default: 60 seconds) has passed +1. If the time that is defined in [TimeBeforeMovingToRehabInSec](../../../server/configuration/cluster-configuration.mdx#clustertimebeforemovingtorehabinsec) (default: 60 seconds) has passed and the node is still unreachable, the node will be moved to a `Rehab` state. -2. If the node remains in `Rehab` for the time defined in [TimeBeforeAddingReplicaInSec](../../../server/configuration/cluster-configuration.mdx#cluster.timebeforeaddingreplicainsec) (default: 900 seconds), +2. If the node remains in `Rehab` for the time defined in [TimeBeforeAddingReplicaInSec](../../../server/configuration/cluster-configuration.mdx#clustertimebeforeaddingreplicainsec) (default: 900 seconds), a new database node will be automatically added to the database group to replace the `Rehab` node. 3. If the `Rehab` node is online again, it will be assigned a [Mentor Node](../../../server/clustering/distribution/highly-available-tasks.mdx#responsible-node) to update it with the recent changes. diff --git a/docs/server/clustering/distribution/highly-available-tasks.mdx b/docs/server/clustering/distribution/highly-available-tasks.mdx index 3aeaa0a193..c0625bcdf3 100644 --- a/docs/server/clustering/distribution/highly-available-tasks.mdx +++ b/docs/server/clustering/distribution/highly-available-tasks.mdx @@ -129,7 +129,7 @@ The failover of a task to another responsible node can be prevented by **pinning * If the node the task is pinned to fails, the task will **not** be executed until the node is back online. When the node awakes, the task will be resumed from the failure point on. * If a node remains offline for the period set by - [cluster.timebeforeaddingreplicainsec](../../../server/configuration/cluster-configuration.mdx#cluster.timebeforeaddingreplicainsec), + [cluster.timebeforeaddingreplicainsec](../../../server/configuration/cluster-configuration.mdx#clustertimebeforeaddingreplicainsec), the cluster observer will attempt to select an available node to replace it in the database group and redistribute the fallen node's tasks, including pinned ones, among database group members. A task can be pinned to a selected node via Studio or using code. diff --git a/docs/server/configuration/ai-integration-configuration.mdx b/docs/server/configuration/ai-integration-configuration.mdx index a435228686..c68ac00e2d 100644 --- a/docs/server/configuration/ai-integration-configuration.mdx +++ b/docs/server/configuration/ai-integration-configuration.mdx @@ -21,9 +21,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * When performing vector search queries, embeddings are also generated from the search term to compare against the stored vectors. * In this article: - * [Ai.Embeddings.MaxBatchSize](../../server/configuration/ai-integration-configuration.mdx#ai.embeddings.maxbatchsize) - * [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#ai.embeddings.maxconcurrentbatches) - * [Ai.Embeddings.MaxFallbackTimeInSec](../../server/configuration/ai-integration-configuration.mdx#ai.embeddings.maxfallbacktimeinsec) + * [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.Embeddings.MaxBatchSize diff --git a/docs/server/configuration/backup-configuration.mdx b/docs/server/configuration/backup-configuration.mdx index fc12abe0c9..a9491c3801 100644 --- a/docs/server/configuration/backup-configuration.mdx +++ b/docs/server/configuration/backup-configuration.mdx @@ -17,16 +17,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Configuration options for backups (both on premise and RavenDB Cloud). -* Another relevant server configuration option can be found [here](../../server/configuration/server-configuration.mdx#server.cpucredits.exhaustionbackupdelayinmin). +* 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#backup.temppath) - * [Backup.LocalRootPath](../../server/configuration/backup-configuration.mdx#backup.localrootpath) - * [Backup.AllowedDestinations](../../server/configuration/backup-configuration.mdx#backup.alloweddestinations) - * [Backup.AllowedAwsRegions](../../server/configuration/backup-configuration.mdx#backup.allowedawsregions) - * [Backup.MaxNumberOfConcurrentBackups](../../server/configuration/backup-configuration.mdx#backup.maxnumberofconcurrentbackups) - * [Backup.ConcurrentBackupsDelayInSec](../../server/configuration/backup-configuration.mdx#backup.concurrentbackupsdelayinsec) - * [Backup.LowMemoryBackupDelayInMin](../../server/configuration/backup-configuration.mdx#backup.lowmemorybackupdelayinmin) + * [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.TempPath diff --git a/docs/server/configuration/cluster-configuration.mdx b/docs/server/configuration/cluster-configuration.mdx index d2ccb1a07c..33f4068e4f 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#cluster.compareexchangeexpireddeletefrequencyinsec) - [Cluster.CompareExchangeTombstonesCleanupIntervalInMin](../../server/configuration/cluster-configuration.mdx#cluster.compareexchangetombstonescleanupintervalinmin) - [Cluster.ElectionTimeoutInMs](../../server/configuration/cluster-configuration.mdx#cluster.electiontimeoutinms) - [Cluster.HardDeleteOnReplacement](../../server/configuration/cluster-configuration.mdx#cluster.harddeleteonreplacement) - [Cluster.LogHistoryMaxEntries](../../server/configuration/cluster-configuration.mdx#cluster.loghistorymaxentries) - [Cluster.MaxChangeVectorDistance](../../server/configuration/cluster-configuration.mdx#cluster.maxchangevectordistance) - [Cluster.MaxClusterTransactionCompareExchangeTombstoneCheckIntervalInMin](../../server/configuration/cluster-configuration.mdx#cluster.maxclustertransactioncompareexchangetombstonecheckintervalinmin) - [Cluster.MaxSizeOfSingleRaftCommandInMb](../../server/configuration/cluster-configuration.mdx#cluster.maxsizeofsingleraftcommandinmb) - [Cluster.MaximalAllowedClusterVersion](../../server/configuration/cluster-configuration.mdx#cluster.maximalallowedclusterversion) - [Cluster.OnErrorDelayTimeInMs](../../server/configuration/cluster-configuration.mdx#cluster.onerrordelaytimeinms) - [Cluster.OperationTimeoutInSec](../../server/configuration/cluster-configuration.mdx#cluster.operationtimeoutinsec) - [Cluster.ReceiveFromWorkerTimeoutInMs](../../server/configuration/cluster-configuration.mdx#cluster.receivefromworkertimeoutinms) - [Cluster.StatsStabilizationTimeInSec](../../server/configuration/cluster-configuration.mdx#cluster.statsstabilizationtimeinsec) - [Cluster.SupervisorSamplePeriodInMs](../../server/configuration/cluster-configuration.mdx#cluster.supervisorsampleperiodinms) - [Cluster.TcpReceiveBufferSizeInBytes](../../server/configuration/cluster-configuration.mdx#cluster.tcpreceivebuffersizeinbytes) - [Cluster.TcpSendBufferSizeInBytes](../../server/configuration/cluster-configuration.mdx#cluster.tcpsendbuffersizeinbytes) - [Cluster.TcpTimeoutInMs](../../server/configuration/cluster-configuration.mdx#cluster.tcptimeoutinms) - [Cluster.TimeBeforeAddingReplicaInSec](../../server/configuration/cluster-configuration.mdx#cluster.timebeforeaddingreplicainsec) - [Cluster.TimeBeforeMovingToRehabInSec](../../server/configuration/cluster-configuration.mdx#cluster.timebeforemovingtorehabinsec) - [Cluster.TimeBeforeRotatingPreferredNodeInSec](../../server/configuration/cluster-configuration.mdx#cluster.timebeforerotatingpreferrednodeinsec) - [Cluster.WorkerSamplePeriodInMs](../../server/configuration/cluster-configuration.mdx#cluster.workersampleperiodinms) + [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) * Server-wide, or database scope: - [Cluster.DisableAtomicDocumentWrites](../../server/configuration/cluster-configuration.mdx#cluster.disableatomicdocumentwrites) - [Cluster.MaxClusterTransactionBatchSize](../../server/configuration/cluster-configuration.mdx#cluster.maxclustertransactionbatchsize) + [Cluster.DisableAtomicDocumentWrites](../../server/configuration/cluster-configuration.mdx#clusterdisableatomicdocumentwrites) + [Cluster.MaxClusterTransactionBatchSize](../../server/configuration/cluster-configuration.mdx#clustermaxclustertransactionbatchsize) ## Cluster.CompareExchangeExpiredDeleteFrequencyInSec diff --git a/docs/server/configuration/configuration-options.mdx b/docs/server/configuration/configuration-options.mdx index 41d4b879da..9b8932b1bf 100644 --- a/docs/server/configuration/configuration-options.mdx +++ b/docs/server/configuration/configuration-options.mdx @@ -20,7 +20,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * 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#settings.json) + * [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) @@ -36,7 +36,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * The server will retrieve these environment variables and apply their values. -To set the [Security.Certificate.Path](../../server/configuration/security-configuration.mdx#security.certificate.path) +To set the [Security.Certificate.Path](../../server/configuration/security-configuration.mdx#securitycertificatepath) configuration key using an environment variable, add the environment variable `RAVEN_Security_Certificate_Path`. @@ -84,7 +84,7 @@ _settings.json_ configuration values **override** their matching Configuration options that include multiple values (like strings separated by `;`) can be configured using regular JSON arrays. -To set [Security.WellKnownCertificates.Admin](../../server/configuration/security-configuration.mdx#security.wellknowncertificates.admin), +To set [Security.WellKnownCertificates.Admin](../../server/configuration/security-configuration.mdx#securitywellknowncertificatesadmin), for example, use: @@ -104,7 +104,7 @@ 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#settings.json) values. +and [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) values. * The server can be configured using command line arguments that are passed to the console application diff --git a/docs/server/configuration/core-configuration.mdx b/docs/server/configuration/core-configuration.mdx index d91c0fcf2d..67534168b9 100644 --- a/docs/server/configuration/core-configuration.mdx +++ b/docs/server/configuration/core-configuration.mdx @@ -14,7 +14,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; # Configuration: Core -[settings.json](../../server/configuration/configuration-options.mdx#settings.json) variables change your server's behavior in various ways. +[settings.json](../../server/configuration/configuration-options.mdx#settingsjson) variables change your server's behavior in various ways. RavenDB reads `settings.json` only during startup. @@ -283,7 +283,7 @@ The URLs which the server should contact when requesting certificates from using ## Features.Availability -This [settings.json](../../server/configuration/configuration-options.mdx#settings.json) variable determines whether to run RavenDB with its standard +This [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) variable determines whether to run RavenDB with its standard features set, or add to a set of experimental features. Some features, like ones recently released, are considered **experimental**. They are disabled by default, you can enable them by setting `Features.Availability` to `Experimental`. diff --git a/docs/server/configuration/database-configuration.mdx b/docs/server/configuration/database-configuration.mdx index 3ce2e86d4c..1838a18f08 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#databases.compression.compressallcollectionsdefault) - [Databases.Compression.CompressRevisionsDefault](../../server/configuration/database-configuration.mdx#databases.compression.compressrevisionsdefault) - [Databases.ConcurrentLoadTimeoutInSec](../../server/configuration/database-configuration.mdx#databases.concurrentloadtimeoutinsec) - [Databases.FrequencyToCheckForIdleInSec](../../server/configuration/database-configuration.mdx#databases.frequencytocheckforidleinsec) - [Databases.MaxConcurrentLoads](../../server/configuration/database-configuration.mdx#databases.maxconcurrentloads) + [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) * Server-wide, or database scope: - [Databases.CollectionOperationTimeoutInSec](../../server/configuration/database-configuration.mdx#databases.collectionoperationtimeoutinsec) - [Databases.DeepCleanupThresholdInMin](../../server/configuration/database-configuration.mdx#databases.deepcleanupthresholdinmin) - [Databases.MaxIdleTimeInSec](../../server/configuration/database-configuration.mdx#databases.maxidletimeinsec) - [Databases.OperationTimeoutInSec](../../server/configuration/database-configuration.mdx#databases.operationtimeoutinsec) - [Databases.PulseReadTransactionLimitInMb](../../server/configuration/database-configuration.mdx#databases.pulsereadtransactionlimitinmb) - [Databases.QueryOperationTimeoutInSec](../../server/configuration/database-configuration.mdx#databases.queryoperationtimeoutinsec) - [Databases.QueryTimeoutInSec](../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec) - [Databases.RegularCleanupThresholdInMin](../../server/configuration/database-configuration.mdx#databases.regularcleanupthresholdinmin) + [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.Compression.CompressAllCollectionsDefault diff --git a/docs/server/configuration/etl-configuration.mdx b/docs/server/configuration/etl-configuration.mdx index a34ded7c80..0c8fbbb5b3 100644 --- a/docs/server/configuration/etl-configuration.mdx +++ b/docs/server/configuration/etl-configuration.mdx @@ -16,16 +16,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [ETL.ExtractAndTransformTimeoutInSec](../../server/configuration/etl-configuration.mdx#etl.extractandtransformtimeoutinsec) - * [ETL.MaxBatchSizeInMb](../../server/configuration/etl-configuration.mdx#etl.maxbatchsizeinmb) - * [ETL.MaxFallbackTimeInSec](../../server/configuration/etl-configuration.mdx#etl.maxfallbacktimeinsec) - * [ETL.MaxNumberOfExtractedDocuments](../../server/configuration/etl-configuration.mdx#etl.maxnumberofextracteddocuments) - * [ETL.MaxNumberOfExtractedItems](../../server/configuration/etl-configuration.mdx#etl.maxnumberofextracteditems) - * [ETL.OLAP.MaxNumberOfExtractedDocuments](../../server/configuration/etl-configuration.mdx#etl.olap.maxnumberofextracteddocuments) - * [ETL.Queue.AzureQueueStorage.TimeToLiveInSec](../../server/configuration/etl-configuration.mdx#etl.queue.azurequeuestorage.timetoliveinsec) - * [ETL.Queue.AzureQueueStorage.VisibilityTimeoutInSec](../../server/configuration/etl-configuration.mdx#etl.queue.azurequeuestorage.visibilitytimeoutinsec) - * [ETL.Queue.Kafka.InitTransactionsTimeoutInSec](../../server/configuration/etl-configuration.mdx#etl.queue.kafka.inittransactionstimeoutinsec) - * [ETL.SQL.CommandTimeoutInSec](../../server/configuration/etl-configuration.mdx#etl.sql.commandtimeoutinsec) + * [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.SQL.CommandTimeoutInSec](../../server/configuration/etl-configuration.mdx#etlsqlcommandtimeoutinsec) ## ETL.ExtractAndTransformTimeoutInSec diff --git a/docs/server/configuration/http-configuration.mdx b/docs/server/configuration/http-configuration.mdx index 2085ce0028..056dc50221 100644 --- a/docs/server/configuration/http-configuration.mdx +++ b/docs/server/configuration/http-configuration.mdx @@ -20,28 +20,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#http.mindataratebytespersec) - * [Http.MinDataRateGracePeriodInSec](../../server/configuration/http-configuration.mdx#http.mindatarategraceperiodinsec) - * [Http.MaxRequestBufferSizeInKb](../../server/configuration/http-configuration.mdx#http.maxrequestbuffersizeinkb) - * [Http.MaxRequestLineSizeInKb](../../server/configuration/http-configuration.mdx#http.maxrequestlinesizeinkb) - * [Http.Http2.KeepAlivePingTimeoutInSec](../../server/configuration/http-configuration.mdx#http.http2.keepalivepingtimeoutinsec) - * [Http.Http2.KeepAlivePingDelayInSec](../../server/configuration/http-configuration.mdx#http.http2.keepalivepingdelayinsec) - * [Http.Http2.MaxStreamsPerConnection](../../server/configuration/http-configuration.mdx#http.http2.maxstreamsperconnection) - * [Http.UseResponseCompression](../../server/configuration/http-configuration.mdx#http.useresponsecompression) - * [Http.AllowResponseCompressionOverHttps](../../server/configuration/http-configuration.mdx#http.allowresponsecompressionoverhttps) - * [Http.GzipResponseCompressionLevel](../../server/configuration/http-configuration.mdx#http.gzipresponsecompressionlevel) - * [Http.DeflateResponseCompressionLevel](../../server/configuration/http-configuration.mdx#http.deflateresponsecompressionlevel) - * [Http.ZstdResponseCompressionLevel](../../server/configuration/http-configuration.mdx#http.zstdresponsecompressionlevel) - * [Http.StaticFilesResponseCompressionLevel](../../server/configuration/http-configuration.mdx#http.staticfilesresponsecompressionlevel) - * [Http.Protocols](../../server/configuration/http-configuration.mdx#http.protocols) - * [Http.AllowSynchronousIO](../../server/configuration/http-configuration.mdx#http.allowsynchronousio) + * [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 * 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#http.mindatarategraceperiodinsec). +* This option must be configured together with [Http.MinDataRateGracePeriod](../../server/configuration/http-configuration.mdx#httpmindatarategraceperiodinsec). - **Type**: `int` - **Default**: `null` - **Scope**: Server-wide only @@ -54,7 +54,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#http.mindataratebytespersec) + This option must be configured together with [Http.MinDataRateBytesPerSec](../../server/configuration/http-configuration.mdx#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/docs/server/configuration/indexing-configuration.mdx b/docs/server/configuration/indexing-configuration.mdx index 9c038517ab..dd8f3e8264 100644 --- a/docs/server/configuration/indexing-configuration.mdx +++ b/docs/server/configuration/indexing-configuration.mdx @@ -26,88 +26,88 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this article: * Server-wide scope: - [Indexing.CleanupIntervalInMin](../../server/configuration/indexing-configuration.mdx#indexing.cleanupintervalinmin) - [Indexing.Corax.VectorSearch.MaxNumberOfThreadsForLocalEmbeddingsGeneration](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.maxnumberofthreadsforlocalembeddingsgeneration) - [Indexing.GlobalScratchSpaceLimitInMb](../../server/configuration/indexing-configuration.mdx#indexing.globalscratchspacelimitinmb) - [Indexing.MaxNumberOfConcurrentlyRunningIndexes](../../server/configuration/indexing-configuration.mdx#indexing.maxnumberofconcurrentlyrunningindexes) - [Indexing.MaxTimeToWaitAfterFlushAndSyncWhenExceedingScratchSpaceLimitInSec](../../server/configuration/indexing-configuration.mdx#indexing.maxtimetowaitafterflushandsyncwhenexceedingscratchspacelimitinsec) - [Indexing.NuGetAllowPreReleasePackages](../../server/configuration/indexing-configuration.mdx#indexing.nugetallowprereleasepackages) - [Indexing.NuGetPackageSourceUrl](../../server/configuration/indexing-configuration.mdx#indexing.nugetpackagesourceurl) - [Indexing.NuGetPackagesPath](../../server/configuration/indexing-configuration.mdx#indexing.nugetpackagespath) - [Indexing.QueryClauseCache.ExpirationScanFrequencyInSec](../../server/configuration/indexing-configuration.mdx#indexing.queryclausecache.expirationscanfrequencyinsec) - [Indexing.QueryClauseCache.RepeatedQueriesCount](../../server/configuration/indexing-configuration.mdx#indexing.queryclausecache.repeatedqueriescount) - [Indexing.QueryClauseCache.SizeInMb](../../server/configuration/indexing-configuration.mdx#indexing.queryclausecache.sizeinmb) + [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) * Server-wide, or database scope: - [Indexing.Auto.ArchivedDataProcessingBehavior](../../server/configuration/indexing-configuration.mdx#indexing.auto.archiveddataprocessingbehavior) - [Indexing.Auto.DeploymentMode](../../server/configuration/indexing-configuration.mdx#indexing.auto.deploymentmode) - [Indexing.Auto.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexing.auto.searchenginetype) - [Indexing.Disable](../../server/configuration/indexing-configuration.mdx#indexing.disable) - [Indexing.DisableQueryOptimizerGeneratedIndexes](../../server/configuration/indexing-configuration.mdx#indexing.disablequeryoptimizergeneratedindexes) - [Indexing.ErrorIndexStartupBehavior](../../server/configuration/indexing-configuration.mdx#indexing.errorindexstartupbehavior) - [Indexing.History.NumberOfRevisions](../../server/configuration/indexing-configuration.mdx#indexing.history.numberofrevisions) - [Indexing.IndexStartupBehavior](../../server/configuration/indexing-configuration.mdx#indexing.indexstartupbehavior) - [Indexing.ResetMode](../../server/configuration/indexing-configuration.mdx#indexing.resetmode) - [Indexing.RunInMemory](../../server/configuration/indexing-configuration.mdx#indexing.runinmemory) - [Indexing.SkipDatabaseIdValidationOnIndexOpening](../../server/configuration/indexing-configuration.mdx#indexing.skipdatabaseidvalidationonindexopening) - [Indexing.Static.ArchivedDataProcessingBehavior](../../server/configuration/indexing-configuration.mdx#indexing.static.archiveddataprocessingbehavior) - [Indexing.Static.DeploymentMode](../../server/configuration/indexing-configuration.mdx#indexing.static.deploymentmode) - [Indexing.Static.RequireAdminToDeployJavaScriptIndexes](../../server/configuration/indexing-configuration.mdx#indexing.static.requireadmintodeployjavascriptindexes) - [Indexing.TempPath](../../server/configuration/indexing-configuration.mdx#indexing.temppath) - [Indexing.TimeBeforeDeletionOfSupersededAutoIndexInSec](../../server/configuration/indexing-configuration.mdx#indexing.timebeforedeletionofsupersededautoindexinsec) - [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforedeletingautoindexmarkedasidleinhrs) - [Indexing.TimeToWaitBeforeMarkingAutoIndexAsIdleInMin](../../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforemarkingautoindexasidleinmin) + [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) * Server-wide, or database, or per index: - [Indexing.AllowStringCompilation](../../server/configuration/indexing-configuration.mdx#indexing.allowstringcompilation) - [Indexing.Analyzers.Default](../../server/configuration/indexing-configuration.mdx#indexing.analyzers.default) - [Indexing.Analyzers.Exact.Default](../../server/configuration/indexing-configuration.mdx#indexing.analyzers.exact.default) - [Indexing.Analyzers.Search.Default](../../server/configuration/indexing-configuration.mdx#indexing.analyzers.search.default) - [Indexing.Corax.DocumentsLimitForCompressionDictionaryCreation](../../server/configuration/indexing-configuration.mdx#indexing.corax.documentslimitforcompressiondictionarycreation) - [Indexing.Corax.IncludeDocumentScore](../../server/configuration/indexing-configuration.mdx#indexing.corax.includedocumentscore) - [Indexing.Corax.IncludeSpatialDistance](../../server/configuration/indexing-configuration.mdx#indexing.corax.includespatialdistance) - [Indexing.Corax.MaxAllocationsAtDictionaryTrainingInMb](../../server/configuration/indexing-configuration.mdx#indexing.corax.maxallocationsatdictionarytraininginmb) - [Indexing.Corax.MaxMemoizationSizeInMb](../../server/configuration/indexing-configuration.mdx#indexing.corax.maxmemoizationsizeinmb) - [Indexing.Corax.Static.ComplexFieldIndexingBehavior](../../server/configuration/indexing-configuration.mdx#indexing.corax.static.complexfieldindexingbehavior) - [Indexing.Corax.UnmanagedAllocationsBatchSizeLimitInMb](../../server/configuration/indexing-configuration.mdx#indexing.corax.unmanagedallocationsbatchsizelimitinmb) - [Indexing.Corax.VectorSearch.DefaultMinimumSimilarity](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultminimumsimilarity) - [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForIndexing](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultnumberofcandidatesforindexing) - [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultnumberofcandidatesforquerying) - [Indexing.Corax.VectorSearch.DefaultNumberOfEdges](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultnumberofedges) - [Indexing.Corax.VectorSearch.MaximumConcurrentBatchesForHnswAcceleration](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.maximumconcurrentbatchesforhnswacceleration) - [Indexing.Corax.VectorSearch.OrderByScoreAutomatically](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.orderbyscoreautomatically) - [Indexing.Encrypted.TransactionSizeLimitInMb](../../server/configuration/indexing-configuration.mdx#indexing.encrypted.transactionsizelimitinmb) - [Indexing.IndexEmptyEntries](../../server/configuration/indexing-configuration.mdx#indexing.indexemptyentries) - [Indexing.IndexMissingFieldsAsNull](../../server/configuration/indexing-configuration.mdx#indexing.indexmissingfieldsasnull) - [Indexing.Lucene.Analyzers.NGram.MaxGram](../../server/configuration/indexing-configuration.mdx#indexing.lucene.analyzers.ngram.maxgram) - [Indexing.Lucene.Analyzers.NGram.MinGram](../../server/configuration/indexing-configuration.mdx#indexing.lucene.analyzers.ngram.mingram) - [Indexing.Lucene.IndexInputType](../../server/configuration/indexing-configuration.mdx#indexing.lucene.indexinputtype) - [Indexing.Lucene.LargeSegmentSizeToMergeInMb](../../server/configuration/indexing-configuration.mdx#indexing.lucene.largesegmentsizetomergeinmb) - [Indexing.Lucene.MaximumSizePerSegmentInMb](../../server/configuration/indexing-configuration.mdx#indexing.lucene.maximumsizepersegmentinmb) - [Indexing.Lucene.MaxTimeForMergesToKeepRunningInSec](../../server/configuration/indexing-configuration.mdx#indexing.lucene.maxtimeformergestokeeprunninginsec) - [Indexing.Lucene.MergeFactor](../../server/configuration/indexing-configuration.mdx#indexing.lucene.mergefactor) - [Indexing.Lucene.NumberOfLargeSegmentsToMergeInSingleBatch](../../server/configuration/indexing-configuration.mdx#indexing.lucene.numberoflargesegmentstomergeinsinglebatch) - [Indexing.Lucene.ReaderTermsIndexDivisor](../../server/configuration/indexing-configuration.mdx#indexing.lucene.readertermsindexdivisor) - [Indexing.Lucene.UseCompoundFileInMerging](../../server/configuration/indexing-configuration.mdx#indexing.lucene.usecompoundfileinmerging) - [Indexing.ManagedAllocationsBatchSizeLimitInMb](../../server/configuration/indexing-configuration.mdx#indexing.managedallocationsbatchsizelimitinmb) - [Indexing.MapBatchSize](../../server/configuration/indexing-configuration.mdx#indexing.mapbatchsize) - [Indexing.MapTimeoutAfterEtagReachedInMin](../../server/configuration/indexing-configuration.mdx#indexing.maptimeoutafteretagreachedinmin) - [Indexing.MapTimeoutInSec](../../server/configuration/indexing-configuration.mdx#indexing.maptimeoutinsec) - [Indexing.MaxStepsForScript](../../server/configuration/indexing-configuration.mdx#indexing.maxstepsforscript) - [Indexing.MaxTimeForDocumentTransactionToRemainOpenInSec](../../server/configuration/indexing-configuration.mdx#indexing.maxtimefordocumenttransactiontoremainopeninsec) - [Indexing.MaxTimeToWaitAfterFlushAndSyncWhenReplacingSideBySideIndexInSec](../../server/configuration/indexing-configuration.mdx#indexing.maxtimetowaitafterflushandsyncwhenreplacingsidebysideindexinsec) - [Indexing.Metrics.Enabled](../../server/configuration/indexing-configuration.mdx#indexing.metrics.enabled) - [Indexing.MinNumberOfMapAttemptsAfterWhichBatchWillBeCanceledIfRunningLowOnMemory](../../server/configuration/indexing-configuration.mdx#indexing.minnumberofmapattemptsafterwhichbatchwillbecanceledifrunninglowonmemory) - [Indexing.MinimumTotalSizeOfJournalsToRunFlushAndSyncWhenReplacingSideBySideIndexInMb](../../server/configuration/indexing-configuration.mdx#indexing.minimumtotalsizeofjournalstorunflushandsyncwhenreplacingsidebysideindexinmb) - [Indexing.NumberOfConcurrentStoppedBatchesIfRunningLowOnMemory](../../server/configuration/indexing-configuration.mdx#indexing.numberofconcurrentstoppedbatchesifrunninglowonmemory) - [Indexing.NumberOfLargeSegmentsToMergeInSingleBatch](../../server/configuration/indexing-configuration.mdx#indexing.numberoflargesegmentstomergeinsinglebatch) - [Indexing.OrderByScoreAutomaticallyWhenBoostingIsInvolved](../../server/configuration/indexing-configuration.mdx#indexing.orderbyscoreautomaticallywhenboostingisinvolved) - [Indexing.OrderByTicksAutomaticallyWhenDatesAreInvolved](../../server/configuration/indexing-configuration.mdx#indexing.orderbyticksautomaticallywhendatesareinvolved) - [Indexing.QueryClauseCache.Disabled](../../server/configuration/indexing-configuration.mdx#indexing.queryclausecache.disabled) - [Indexing.QueryClauseCache.RepeatedQueriesTimeFrameInSec](../../server/configuration/indexing-configuration.mdx#indexing.queryclausecache.repeatedqueriestimeframeinsec) - [Indexing.ScratchSpaceLimitInMb](../../server/configuration/indexing-configuration.mdx#indexing.scratchspacelimitinmb) - [Indexing.Static.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexing.static.searchenginetype) - [Indexing.Throttling.TimeIntervalInMs](../../server/configuration/indexing-configuration.mdx#indexing.throttling.timeintervalinms) - [Indexing.TimeSinceLastQueryAfterWhichDeepCleanupCanBeExecutedInMin](../../server/configuration/indexing-configuration.mdx#indexing.timesincelastqueryafterwhichdeepcleanupcanbeexecutedinmin) - [Indexing.TransactionSizeLimitInMb](../../server/configuration/indexing-configuration.mdx#indexing.transactionsizelimitinmb) + [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.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.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.CleanupIntervalInMin @@ -724,7 +724,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#indexing.numberoflargesegmentstomergeinsinglebatch) in a single batch. + We won't merge more than [Indexing.NumberOfLargeSegmentsToMergeInSingleBatch](../../server/configuration/indexing-configuration.mdx#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` @@ -787,7 +787,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#indexing.largesegmentsizetomergeinmb) to merge in a single batch. +* Number of large segments defined by [Indexing.LargeSegmentSizeToMergeInMb](../../server/configuration/indexing-configuration.mdx#indexinglargesegmentsizetomergeinmb) to merge in a single batch. - **Type**: `int` - **Default**: `2` - **Scope**: Server-wide, or per database, or per index @@ -969,7 +969,7 @@ EXPERT ONLY: * Disable the query clause cache for a server, database, or a single index. * The default value is set by the constructor of class `IndexingConfiguration`. - It will be `true` if your core configuration key [Features.Availability](../../server/configuration/core-configuration.mdx#features.availability) is Not set to 'Experimental'. + It will be `true` if your core configuration key [Features.Availability](../../server/configuration/core-configuration.mdx#featuresavailability) is Not set to 'Experimental'. - **Type**: `bool` - **Default**: `DefaultValueSetInConstructor` - **Scope**: Server-wide, or per database, or per index diff --git a/docs/server/configuration/license-configuration.mdx b/docs/server/configuration/license-configuration.mdx index b2384a222c..2178f7f76c 100644 --- a/docs/server/configuration/license-configuration.mdx +++ b/docs/server/configuration/license-configuration.mdx @@ -118,7 +118,7 @@ Disable automatic updates of the license from the License Server (api.ravendb.ne 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#license.path) configuration +* Setting the [License.Path](../../server/configuration/license-configuration.mdx#licensepath) configuration * Replacing the _license.json_ file on disk - **Type**: `bool` - **Default**: `false` diff --git a/docs/server/configuration/logs-configuration.mdx b/docs/server/configuration/logs-configuration.mdx index cb2ede4ca1..8722b1c4f7 100644 --- a/docs/server/configuration/logs-configuration.mdx +++ b/docs/server/configuration/logs-configuration.mdx @@ -20,24 +20,24 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: * RavenDB logging configuration keys: - [Logs.ArchiveAboveSizeInMb](../../server/configuration/logs-configuration.mdx#logs.archiveabovesizeinmb) - [Logs.ConfigPath](../../server/configuration/logs-configuration.mdx#logs.configpath) - [Logs.EnableArchiveFileCompression](../../server/configuration/logs-configuration.mdx#logs.enablearchivefilecompression) - [Logs.MaxArchiveDays](../../server/configuration/logs-configuration.mdx#logs.maxarchivedays) - [Logs.MaxArchiveFiles](../../server/configuration/logs-configuration.mdx#logs.maxarchivefiles) - [Logs.Microsoft.MinLevel](../../server/configuration/logs-configuration.mdx#logs.microsoft.minlevel) - [Logs.MinLevel](../../server/configuration/logs-configuration.mdx#logs.minlevel) - [Logs.NuGet.AdditionalPackages](../../server/configuration/logs-configuration.mdx#logs.nuget.additionalpackages) - [Logs.NuGet.AllowPreReleasePackages](../../server/configuration/logs-configuration.mdx#logs.nuget.allowprereleasepackages) - [Logs.NuGet.PackagesPath](../../server/configuration/logs-configuration.mdx#logs.nuget.packagespath) - [Logs.NuGet.PackageSourceUrl](../../server/configuration/logs-configuration.mdx#logs.nuget.packagesourceurl) - [Logs.Path](../../server/configuration/logs-configuration.mdx#logs.path) - [Logs.ThrowConfigExceptions](../../server/configuration/logs-configuration.mdx#logs.throwconfigexceptions) + [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.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) * Internal NLog configuration keys: - [Logs.Internal.Level](../../server/configuration/logs-configuration.mdx#logs.internal.level) - [Logs.Internal.LogToStandardError](../../server/configuration/logs-configuration.mdx#logs.internal.logtostandarderror) - [Logs.Internal.LogToStandardOutput](../../server/configuration/logs-configuration.mdx#logs.internal.logtostandardoutput) - [Logs.Internal.Path](../../server/configuration/logs-configuration.mdx#logs.internal.path) + [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.ArchiveAboveSizeInMb diff --git a/docs/server/configuration/monitoring-configuration.mdx b/docs/server/configuration/monitoring-configuration.mdx index 309846e8ce..596e653626 100644 --- a/docs/server/configuration/monitoring-configuration.mdx +++ b/docs/server/configuration/monitoring-configuration.mdx @@ -17,45 +17,45 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: * OpenTelemetry monitoring: - [Monitoring.OpenTelemetry.ConsoleExporter](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.consoleexporter) - [Monitoring.OpenTelemetry.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.enabled) - [Monitoring.OpenTelemetry.Meters.AspNetCore.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.aspnetcore.enabled) - [Monitoring.OpenTelemetry.Meters.Runtime.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.runtime.enabled) - [Monitoring.OpenTelemetry.Meters.Server.CPUCredits.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.cpucredits.enabled) - [Monitoring.OpenTelemetry.Meters.Server.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.enabled) - [Monitoring.OpenTelemetry.Meters.Server.GC.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.gc.enabled) - [Monitoring.OpenTelemetry.Meters.Server.General.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.general.enabled) - [Monitoring.OpenTelemetry.Meters.Server.Requests.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.requests.enabled) - [Monitoring.OpenTelemetry.Meters.Server.Resources.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.resources.enabled) - [Monitoring.OpenTelemetry.Meters.Server.Storage.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.storage.enabled) - [Monitoring.OpenTelemetry.Meters.Server.TotalDatabases.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.totaldatabases.enabled) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.enabled) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Endpoint](../..//server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.endpoint) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.ExportProcessorType](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.exportprocessortype) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Headers](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.headers) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Protocol](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.protocol) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Timeout](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.timeout) - [Monitoring.OpenTelemetry.ServiceInstanceId](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.serviceinstanceid) + [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) * SNMP monitoring - [Monitoring.Snmp.AuthenticationPassword](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationpassword) - [Monitoring.Snmp.AuthenticationPassword.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationpassword.secondary) - [Monitoring.Snmp.AuthenticationProtocol](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationprotocol) - [Monitoring.Snmp.AuthenticationProtocol.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationprotocol.secondary) - [Monitoring.Snmp.AuthenticationUser](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationuser) - [Monitoring.Snmp.AuthenticationUser.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationuser.secondary) - [Monitoring.Snmp.Community](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.community) - [Monitoring.Snmp.DisableTimeWindowChecks](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.disabletimewindowchecks) - [Monitoring.Snmp.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.enabled) - [Monitoring.Snmp.Port](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.port) - [Monitoring.Snmp.PrivacyPassword](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.privacypassword) - [Monitoring.Snmp.PrivacyPassword.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.privacypassword.secondary) - [Monitoring.Snmp.PrivacyProtocol](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.privacyprotocol) - [Monitoring.Snmp.PrivacyProtocol.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.privacyprotocol.secondary) - [Monitoring.Snmp.SupportedVersions](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.supportedversions) + [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) * Other monitoring: - [Monitoring.Cpu.Exec](../../server/configuration/monitoring-configuration.mdx#monitoring.cpu.exec) - [Monitoring.Cpu.Exec.Arguments](../../server/configuration/monitoring-configuration.mdx#monitoring.cpu.exec.arguments) - [Monitoring.Disk.ReadStatsDebounceTimeInMs](../../server/configuration/monitoring-configuration.mdx#monitoring.disk.readstatsdebouncetimeinms) + [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.OpenTelemetry.ConsoleExporter diff --git a/docs/server/configuration/patching-configuration.mdx b/docs/server/configuration/patching-configuration.mdx index 0bfdd7512e..1639b36e61 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#patching.allowstringcompilation) - * [Patching.MaxStepsForScript](../../server/configuration/patching-configuration.mdx#patching.maxstepsforscript) - * [Patching.StrictMode](../../server/configuration/patching-configuration.mdx#patching.strictmode) + * [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 diff --git a/docs/server/configuration/performance-hints-configuration.mdx b/docs/server/configuration/performance-hints-configuration.mdx index 7cb37af2d3..ae8237050d 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#performancehints.documents.hugedocumentscollectionsize) - * [PerformanceHints.Documents.HugeDocumentSizeInMb](../../server/configuration/performance-hints-configuration.mdx#performancehints.documents.hugedocumentsizeinmb) - * [PerformanceHints.Indexing.AlertWhenSourceDocumentIncludedInOutput](../../server/configuration/performance-hints-configuration.mdx#performancehints.indexing.alertwhensourcedocumentincludedinoutput) - * [PerformanceHints.Indexing.MaxDepthOfRecursionInLinqSelect](../../server/configuration/performance-hints-configuration.mdx#performancehints.indexing.maxdepthofrecursioninlinqselect) - * [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../../server/configuration/performance-hints-configuration.mdx#performancehints.indexing.maxindexoutputsperdocument) - * [PerformanceHints.Indexing.MaxNumberOfLoadsPerReference](../../server/configuration/performance-hints-configuration.mdx#performancehints.indexing.maxnumberofloadsperreference) - * [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehints.maxnumberofresults) - * [PerformanceHints.Memory.MinSwapSizeInMb](../../server/configuration/performance-hints-configuration.mdx#performancehints.memory.minswapsizeinmb) - * [PerformanceHints.TooLongRequestThresholdInSec](../../server/configuration/performance-hints-configuration.mdx#performancehints.toolongrequestthresholdinsec) + * [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 diff --git a/docs/server/configuration/queue-sink-configuration.mdx b/docs/server/configuration/queue-sink-configuration.mdx index 543abbf9a5..d551ff6821 100644 --- a/docs/server/configuration/queue-sink-configuration.mdx +++ b/docs/server/configuration/queue-sink-configuration.mdx @@ -18,7 +18,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; The maximum number of pulled messages consumed in a single batch. - **Default**: `8192` -- **Scope**: [Server-wide](../../server/configuration/configuration-options.mdx#settings.json) +- **Scope**: [Server-wide](../../server/configuration/configuration-options.mdx#settingsjson) or [per database](../../studio/database/settings/database-settings.mdx#view-database-settings) @@ -30,7 +30,7 @@ mode (i.e. suspending the process) after a connection failure. - **Default**: `15*60` - **TimeUnit**: `TimeUnit.Seconds` -- **Scope**: [Server-wide](../../server/configuration/configuration-options.mdx#settings.json) +- **Scope**: [Server-wide](../../server/configuration/configuration-options.mdx#settingsjson) or [per database](../../studio/database/settings/database-settings.mdx#view-database-settings) diff --git a/docs/server/configuration/security-configuration.mdx b/docs/server/configuration/security-configuration.mdx index faf576ef01..cd3a397b43 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#security.auditlog.enablearchivefilecompression) - [Security.AuditLog.FolderPath](../../server/configuration/security-configuration.mdx#security.auditlog.folderpath) - [Security.AuditLog.ArchiveAboveSizeInMb](../../server/configuration/security-configuration.mdx#security.auditlog.archiveabovesizeinmb) - [Security.AuditLog.MaxArchiveDays](../../server/configuration/security-configuration.mdx#security.auditlog.maxarchivedays) + [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.Certificate: - [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#security.certificate.change.exec) - [Security.Certificate.Change.Exec.Arguments](../../server/configuration/security-configuration.mdx#security.certificate.change.exec.arguments) - [Security.Certificate.Exec](../../server/configuration/security-configuration.mdx#security.certificate.exec) - [Security.Certificate.Exec.TimeoutInSec](../../server/configuration/security-configuration.mdx#security.certificate.exec.timeoutinsec) - [Security.Certificate.ExpiringThresholdInDays](../../server/configuration/security-configuration.mdx#security.certificate.expiringthresholdindays) - [Security.Certificate.LetsEncrypt.Email](../../server/configuration/security-configuration.mdx#security.certificate.letsencrypt.email) - [Security.Certificate.Load.Exec](../../server/configuration/security-configuration.mdx#security.certificate.load.exec) - [Security.Certificate.Load.Exec.Arguments](../../server/configuration/security-configuration.mdx#security.certificate.load.exec.arguments) - [Security.Certificate.Password](../../server/configuration/security-configuration.mdx#security.certificate.password) - [Security.Certificate.Path](../../server/configuration/security-configuration.mdx#security.certificate.path) - [Security.Certificate.Renew.Exec](../../server/configuration/security-configuration.mdx#security.certificate.renew.exec) - [Security.Certificate.Renew.Exec.Arguments](../../server/configuration/security-configuration.mdx#security.certificate.renew.exec.arguments) - [Security.Certificate.Validation.Exec](../../server/configuration/security-configuration.mdx#security.certificate.validation.exec) - [Security.Certificate.Validation.Exec.Arguments](../../server/configuration/security-configuration.mdx#security.certificate.validation.exec.arguments) - [Security.Certificate.Validation.Exec.TimeoutInSec](../../server/configuration/security-configuration.mdx#security.certificate.validation.exec.timeoutinsec) - [Security.Certificate.Validation.KeyUsages](../../server/configuration/security-configuration.mdx#security.certificate.validation.keyusages) + [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.Csrf: - [Security.Csrf.AdditionalOriginHeaders](../../server/configuration/security-configuration.mdx#security.csrf.additionaloriginheaders) - [Security.Csrf.Enabled](../../server/configuration/security-configuration.mdx#security.csrf.enabled) - [Security.Csrf.TrustedOrigins](../../server/configuration/security-configuration.mdx#security.csrf.trustedorigins) + [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.MasterKey: - [Security.MasterKey.Exec](../../server/configuration/security-configuration.mdx#security.masterkey.exec) - [Security.MasterKey.Exec.Arguments](../../server/configuration/security-configuration.mdx#security.masterkey.exec.arguments) - [Security.MasterKey.Exec.TimeoutInSec](../../server/configuration/security-configuration.mdx#security.masterkey.exec.timeoutinsec) - [Security.MasterKey.Path](../../server/configuration/security-configuration.mdx#security.masterkey.path) + [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.TwoFactor: - [Security.TwoFactor.DefaultSessionDurationInMin](../../server/configuration/security-configuration.mdx#security.twofactor.defaultsessiondurationinmin) - [Security.TwoFactor.MaxSessionDurationInMin](../../server/configuration/security-configuration.mdx#security.twofactor.maxsessiondurationinmin) + [Security.TwoFactor.DefaultSessionDurationInMin](../../server/configuration/security-configuration.mdx#securitytwofactordefaultsessiondurationinmin) + [Security.TwoFactor.MaxSessionDurationInMin](../../server/configuration/security-configuration.mdx#securitytwofactormaxsessiondurationinmin) * Certificate and issuer validation: - [Security.WellKnownCertificates.Admin](../../server/configuration/security-configuration.mdx#security.wellknowncertificates.admin) - [Security.WellKnownIssuerHashes.Admin](../../server/configuration/security-configuration.mdx#security.wellknownissuerhashes.admin) - [Security.WellKnownIssuers.Admin](../../server/configuration/security-configuration.mdx#security.wellknownissuers.admin) - [Security.WellKnownIssuers.Admin.ValidateCertificateNames](../../server/configuration/security-configuration.mdx#security.wellknownissuers.admin.validatecertificatenames) + [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) * Other: - [Security.DisableHsts](../../server/configuration/security-configuration.mdx#security.disablehsts) - [Security.DisableHttpsRedirection](../../server/configuration/security-configuration.mdx#security.disablehttpsredirection) - [Security.DoNotConsiderMemoryLockFailureAsCatastrophicError](../../server/configuration/security-configuration.mdx#security.donotconsidermemorylockfailureascatastrophicerror) - [Security.TlsCipherSuites](../../server/configuration/security-configuration.mdx#security.tlsciphersuites) - [Security.UnsecuredAccessAllowed](../../server/configuration/security-configuration.mdx#security.unsecuredaccessallowed) + [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.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#security.certificate.path) is not defined. +Note: it will only be triggered if [Security.Certificate.Path](../../server/configuration/security-configuration.mdx#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#security.certificate.change.exec) command or executable. +The command line arguments for the [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#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#security.certificate.load.exec) -along with [Security.Certificate.Renew.Exec](../../server/configuration/security-configuration.mdx#security.certificate.renew.exec) -and [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#security.certificate.change.exec) instead. +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. @@ -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#security.certificate.load.exec) - * [Security.Certificate.Renew.Exec](../../server/configuration/security-configuration.mdx#security.certificate.renew.exec) - * [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#security.certificate.change.exec) + * [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) - **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#security.certificate.path) setting takes precedence over this executable. +* The [Security.Certificate.Path](../../server/configuration/security-configuration.mdx#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#security.certificate.load.exec) command or executable. +The command line arguments for the [Security.Certificate.Load.Exec](../../server/configuration/security-configuration.mdx#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#security.certificate.change.exec) +* The executable specified in [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#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#security.certificate.renew.exec.arguments) command or executable. +The command line arguments for the [Security.Certificate.Renew.Exec](../../server/configuration/security-configuration.mdx#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#security.certificate.validation.exec.arguments) command or executable. +The optional user arguments for the [Security.Certificate.Validation.Exec](../../server/configuration/security-configuration.mdx#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#security.certificate.validation.exec.arguments) executable to exit. +The number of seconds to wait for the [Security.Certificate.Validation.Exec](../../server/configuration/security-configuration.mdx#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#security.masterkey.exec) command or executable. +The command line arguments for the [Security.MasterKey.Exec](../../server/configuration/security-configuration.mdx#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#security.wellknownissuers.admin) instead. +Use [Security.WellKnownIssuers.Admin](../../server/configuration/security-configuration.mdx#securitywellknownissuersadmin) instead. diff --git a/docs/server/configuration/server-configuration.mdx b/docs/server/configuration/server-configuration.mdx index 05f8f5d5af..ddfa8732c1 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#server.maxtimefortasktowaitfordatabasetoloadinsec) - * [Server.ProcessAffinityMask](../../server/configuration/server-configuration.mdx#server.processaffinitymask) - * [Server.IndexingAffinityMask](../../server/configuration/server-configuration.mdx#server.indexingaffinitymask) - * [Server.NumberOfUnusedCoresByIndexes](../../server/configuration/server-configuration.mdx#server.numberofunusedcoresbyindexes) - * [Server.CpuCredits.ExhaustionBackupDelayInMin](../../server/configuration/server-configuration.mdx#server.cpucredits.exhaustionbackupdelayinmin) - * [Server.Tcp.Compression.Disable](../../server/configuration/server-configuration.mdx#server.tcp.compression.disable) + * [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 diff --git a/docs/server/configuration/storage-configuration.mdx b/docs/server/configuration/storage-configuration.mdx index 556fa7a7f7..6f5830c572 100644 --- a/docs/server/configuration/storage-configuration.mdx +++ b/docs/server/configuration/storage-configuration.mdx @@ -31,7 +31,7 @@ The following configuration options allow you configure [the storage engine](../ * The Databases temporary files will be written to `"/Databases/{database-name}"`. * The Configuration temporary files will be written to `"/Databases/{database-name}/Configuration"`. -* To specify a different path for the indexes temporary files go to [Indexing.TempPath](../../server/configuration/indexing-configuration.mdx#indexing.temppath). +* To specify a different path for the indexes temporary files go to [Indexing.TempPath](../../server/configuration/indexing-configuration.mdx#indexingtemppath). * Learn more about RavenDB directory structure [here](../../server/storage/directory-structure.mdx). - **Type**: `string` diff --git a/docs/server/configuration/subscription-configuration.mdx b/docs/server/configuration/subscription-configuration.mdx index 090f050f0b..7d1e19e83c 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#subscriptions.archiveddataprocessingbehavior) - * [Subscriptions.MaxNumberOfConcurrentConnections](../../server/configuration/subscription-configuration.mdx#subscriptions.maxnumberofconcurrentconnections) + * [Subscriptions.ArchivedDataProcessingBehavior](../../server/configuration/subscription-configuration.mdx#subscriptionsarchiveddataprocessingbehavior) + * [Subscriptions.MaxNumberOfConcurrentConnections](../../server/configuration/subscription-configuration.mdx#subscriptionsmaxnumberofconcurrentconnections) diff --git a/docs/server/embedded.mdx b/docs/server/embedded.mdx index a6a47b2be2..902004d2f5 100644 --- a/docs/server/embedded.mdx +++ b/docs/server/embedded.mdx @@ -34,7 +34,7 @@ export const supportedLanguages = ["csharp", "java"]; * [Restarting the Server](../server/embedded.mdx#restarting-the-server) * [ServerProcessExited Event](../server/embedded.mdx#serverprocessexited-event) * [Licensing options](../server/embedded.mdx#licensing-options) - * [.NET FrameworkVersion](../server/embedded.mdx#.net-frameworkversion) + * [.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) diff --git a/docs/server/kb/javascript-engine.mdx b/docs/server/kb/javascript-engine.mdx index a7e0c4cd61..68c302b759 100644 --- a/docs/server/kb/javascript-engine.mdx +++ b/docs/server/kb/javascript-engine.mdx @@ -47,9 +47,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * **Execution limitations**: * RavenDB limits the amount of statements that can be performed for each document processing. - The default value is **10,000** and it can be set using the [Patching.MaxStepsForScript](../../server/configuration/patching-configuration.mdx#patching.maxstepsforscript) configuration. + The default value is **10,000** and it can be set using the [Patching.MaxStepsForScript](../../server/configuration/patching-configuration.mdx#patchingmaxstepsforscript) configuration. * RavenDB limits the amount of cached Jint engines. - The default value is **2,048** and it can be set using the [Patching.MaxNumberOfCachedScripts](../../server/configuration/patching-configuration.mdx#patching.maxstepsforscript) configuration. + The default value is **2,048** and it can be set using the [Patching.MaxNumberOfCachedScripts](../../server/configuration/patching-configuration.mdx#patchingmaxstepsforscript) configuration. * Recursive calls within scripts are limited to a depth of **64**, a constant value that cannot be modified. diff --git a/docs/server/ongoing-tasks/etl/basics.mdx b/docs/server/ongoing-tasks/etl/basics.mdx index 38c5bd9a99..6ddb0f6c51 100644 --- a/docs/server/ongoing-tasks/etl/basics.mdx +++ b/docs/server/ongoing-tasks/etl/basics.mdx @@ -198,16 +198,16 @@ For each ETL type, the target must be: Documents are extracted and transformed by the ETL process in a batch manner. The number of documents processed depends on the following configuration limits: -* [`ETL.ExtractAndTransformTimeoutInSec`](../../../server/configuration/etl-configuration.mdx#etl.extractandtransformtimeoutinsec) (default: 30 sec) +* [`ETL.ExtractAndTransformTimeoutInSec`](../../../server/configuration/etl-configuration.mdx#etlextractandtransformtimeoutinsec) (default: 30 sec) Time-frame for the extraction and transformation stages (in seconds), after which the loading stage will start. -* [`ETL.MaxNumberOfExtractedDocuments`](../../../server/configuration/etl-configuration.mdx#etl.maxnumberofextracteddocuments) (default: 8192) +* [`ETL.MaxNumberOfExtractedDocuments`](../../../server/configuration/etl-configuration.mdx#etlmaxnumberofextracteddocuments) (default: 8192) Maximum number of extracted documents in an ETL batch. -* [`ETL.MaxNumberOfExtractedItems`](../../../server/configuration/etl-configuration.mdx#etl.maxnumberofextracteditems) (default: 8192) +* [`ETL.MaxNumberOfExtractedItems`](../../../server/configuration/etl-configuration.mdx#etlmaxnumberofextracteditems) (default: 8192) Maximum number of extracted items (documents, counters) in an ETL batch. -* [`ETL.MaxBatchSizeInMb`](../../../server/configuration/etl-configuration.mdx#etl.maxbatchsizeinmb) (default: 64 MB) +* [`ETL.MaxBatchSizeInMb`](../../../server/configuration/etl-configuration.mdx#etlmaxbatchsizeinmb) (default: 64 MB) Maximum size of an ETL batch in MB. @@ -259,7 +259,7 @@ You will be notified if any of the following events happen: If the ETL cannot proceed the load stage (e.g. it can't connect to the destination) then it enters the fallback mode. The fallback mode means suspending the process and retrying it periodically. The fallback time starts from 5 seconds and it's doubled on every consecutive error according to the time passed since the last error, -but it never crosses [`ETL.MaxFallbackTimeInSec`](../../../server/configuration/etl-configuration.mdx#etl.maxfallbacktimeinsec) configuration (default: 900 sec). +but it never crosses [`ETL.MaxFallbackTimeInSec`](../../../server/configuration/etl-configuration.mdx#etlmaxfallbacktimeinsec) configuration (default: 900 sec). Once the process is in the fallback mode, then the _Reconnect_ state is shown in the Studio. diff --git a/docs/server/ongoing-tasks/etl/olap.mdx b/docs/server/ongoing-tasks/etl/olap.mdx index 0902fb1757..33d0b31b61 100644 --- a/docs/server/ongoing-tasks/etl/olap.mdx +++ b/docs/server/ongoing-tasks/etl/olap.mdx @@ -109,7 +109,7 @@ This is the list of different settings objects that the `OlapConnectionString` o | Property | Type | Description | | - | - | - | -| `FolderPath` | `string` | Path to local folder. If this property is not set, the data is saved to the location specified in [the setting `Storage.TempPath`](../../../server/configuration/storage-configuration.mdx#storage.temppath). If _that_ setting has no value, the data is instead saved to the location specified in [the setting `CoreConfiguration.DataDirectory`](../../../server/configuration/core-configuration.mdx#datadir). | +| `FolderPath` | `string` | Path to local folder. If this property is not set, the data is saved to the location specified in [the setting `Storage.TempPath`](../../../server/configuration/storage-configuration.mdx#storagetemppath). If _that_ setting has no value, the data is instead saved to the location specified in [the setting `CoreConfiguration.DataDirectory`](../../../server/configuration/core-configuration.mdx#datadir). | #### `FtpSettings` 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 fdae2cfb71..5eb953e060 100644 --- a/docs/server/ongoing-tasks/etl/queue-etl/azure-queue.mdx +++ b/docs/server/ongoing-tasks/etl/queue-etl/azure-queue.mdx @@ -30,7 +30,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * [Azure Functions](https://learn.microsoft.com/en-us/azure/azure-functions/functions-overview?pivots=programming-language-csharp) can be triggered to consume and process messages that are sent to Azure queues, enabling powerful and flexible workflows. - The message visibility period and life span in the Queue can be customized through these [ETL configuration options](../../../../server/configuration/etl-configuration.mdx#etl.queue.azurequeuestorage.timetoliveinsec). + The message visibility period and life span in the Queue can be customized through these [ETL configuration options](../../../../server/configuration/etl-configuration.mdx#etlqueueazurequeuestoragetimetoliveinsec). * Read more about Azure Queue Storage in the platform's [official documentation](https://learn.microsoft.com/en-us/azure/storage/queues/storage-queues-introduction). * This article focuses on how to create an Azure Queue Storage ETL task using the Client API. diff --git a/docs/server/ongoing-tasks/etl/sql.mdx b/docs/server/ongoing-tasks/etl/sql.mdx index 7c20ea955a..12991c890e 100644 --- a/docs/server/ongoing-tasks/etl/sql.mdx +++ b/docs/server/ongoing-tasks/etl/sql.mdx @@ -311,7 +311,7 @@ The SQL ETL task does not support sending [Counters](../../../document-extension * **Command timeout** Number of seconds after which SQL command will timeout. - It overrides the value defined in the [ETL.SQL.CommandTimeoutInSec](../../../server/configuration/etl-configuration.mdx#etl.sql.commandtimeoutinsec) configuration key. + It overrides the value defined in the [ETL.SQL.CommandTimeoutInSec](../../../server/configuration/etl-configuration.mdx#etlsqlcommandtimeoutinsec) configuration key. Default: `null` (use provider default). * **Parameterized deletes** Control whether DELETE statements generated during the ETL process use parameterized SQL queries, 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 fe42113ee4..9262645a22 100644 --- a/docs/server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx +++ b/docs/server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx @@ -303,9 +303,9 @@ AddQueueSinkOperationResult addQueueSinkOperationResult = Use these configuration options to gain more control over queue sink tasks. -* [QueueSink.MaxBatchSize](../../../server/configuration/queue-sink-configuration.mdx#queuesink.maxbatchsize) +* [QueueSink.MaxBatchSize](../../../server/configuration/queue-sink-configuration.mdx#queuesinkmaxbatchsize) The maximum number of pulled messages consumed in a single batch. -* [QueueSink.MaxFallbackTimeInSec](../../../server/configuration/queue-sink-configuration.mdx#queuesink.maxfallbacktimeinsec) +* [QueueSink.MaxFallbackTimeInSec](../../../server/configuration/queue-sink-configuration.mdx#queuesinkmaxfallbacktimeinsec) The maximum number of seconds the Queue Sink process will be in a fallback mode (i.e. suspending the process) after a connection failure. 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 6e12efa79e..b4e2fb6a6a 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 @@ -290,9 +290,9 @@ AddQueueSinkOperationResult addQueueSinkOperationResult = Use these configuration options to gain more control over queue sink tasks. -* [QueueSink.MaxBatchSize](../../../server/configuration/queue-sink-configuration.mdx#queuesink.maxbatchsize) +* [QueueSink.MaxBatchSize](../../../server/configuration/queue-sink-configuration.mdx#queuesinkmaxbatchsize) The maximum number of pulled messages consumed in a single batch. -* [QueueSink.MaxFallbackTimeInSec](../../../server/configuration/queue-sink-configuration.mdx#queuesink.maxfallbacktimeinsec) +* [QueueSink.MaxFallbackTimeInSec](../../../server/configuration/queue-sink-configuration.mdx#queuesinkmaxfallbacktimeinsec) The maximum number of seconds the Queue Sink process will be in a fallback mode (i.e. suspending the process) after a connection failure. diff --git a/docs/server/security/audit-log/audit-log-overview.mdx b/docs/server/security/audit-log/audit-log-overview.mdx index a607b0463e..996c0308f3 100644 --- a/docs/server/security/audit-log/audit-log-overview.mdx +++ b/docs/server/security/audit-log/audit-log-overview.mdx @@ -32,15 +32,15 @@ import LanguageContent from "@site/src/components/LanguageContent"; ## Enabling the audit log * **To enable writing to the audit log**, set the following configuration key: - * [Security.AuditLog.FolderPath](../../../server/configuration/security-configuration.mdx#security.auditlog.folderpath) - set the path to a folder where RavenDB will store the audit logs. + * [Security.AuditLog.FolderPath](../../../server/configuration/security-configuration.mdx#securityauditlogfolderpath) - set the path to a folder where RavenDB will store the audit logs. * In addition, the following configurations are available: - * [Security.AuditLog.ArchiveAboveSizeInMb](../../../server/configuration/security-configuration.mdx#security.auditlog.archiveabovesizeinmb) + * [Security.AuditLog.ArchiveAboveSizeInMb](../../../server/configuration/security-configuration.mdx#securityauditlogarchiveabovesizeinmb) The maximum size an audit log file may reach before it is archived and logging is directed to a new file. - * [Security.AuditLog.EnableArchiveFileCompression](../../../server/configuration/security-configuration.mdx#security.auditlog.enablearchivefilecompression) - determine whether to compress the audit log files. - * [Security.AuditLog.MaxArchiveDays](../../../server/configuration/security-configuration.mdx#security.auditlog.maxarchivedays) - the maximum number of days that an archived audit log file is kept. - * [Security.AuditLog.MaxArchiveFiles](../../../server/configuration/security-configuration.mdx#security.auditlog.maxarchivefiles) - the maximum number of archived audit log files to keep. - * [Logs.ArchiveAboveSizeInMb](../../../server/configuration/logs-configuration.mdx#logs.archiveabovesizeinmb) - a new log file is created when this limit is reached (or daily). + * [Security.AuditLog.EnableArchiveFileCompression](../../../server/configuration/security-configuration.mdx#securityauditlogenablearchivefilecompression) - determine whether to compress the audit log files. + * [Security.AuditLog.MaxArchiveDays](../../../server/configuration/security-configuration.mdx#securityauditlogmaxarchivedays) - the maximum number of days that an archived audit log file is kept. + * [Security.AuditLog.MaxArchiveFiles](../../../server/configuration/security-configuration.mdx#securityauditlogmaxarchivefiles) - the maximum number of archived audit log files to keep. + * [Logs.ArchiveAboveSizeInMb](../../../server/configuration/logs-configuration.mdx#logsarchiveabovesizeinmb) - a new log file is created when this limit is reached (or daily). * Learn how to set configuration keys in this [configuration overview](../../../server/configuration/configuration-options.mdx). diff --git a/docs/server/security/authentication/certificate-configuration.mdx b/docs/server/security/authentication/certificate-configuration.mdx index fbac3d6b4d..6b1ac65ded 100644 --- a/docs/server/security/authentication/certificate-configuration.mdx +++ b/docs/server/security/authentication/certificate-configuration.mdx @@ -38,7 +38,7 @@ authentication in a much easier and faster way with automatic certificate renewa ## Prerequisites To enable authentication, either `Security.Certificate.Path` or `Security.Certificate.Load.Exec` must be set in [settings.json](../../configuration/configuration-options.mdx#json). - Please note that `Security.Certificate.Load.Exec` has replaced the old `Security.Certificate.Exec` as of 4.2 - [see FAQ](../../../server/security/common-errors-and-faq.mdx#automatic-cluster-certificate-renewal-following-migration-to-4.2). + Please note that `Security.Certificate.Load.Exec` has replaced the old `Security.Certificate.Exec` as of 4.2 - [see FAQ](../../../server/security/common-errors-and-faq.mdx#automatic-cluster-certificate-renewal-following-migration-to-42). #### 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). @@ -81,7 +81,7 @@ and include a basic (`Key Usage`) field and an enhanced (`Enhanced Key Usage`) f #### Certificate Location -A [settings.json](../../configuration/configuration-options.mdx#settings.json) file must reside in each node's `Server` folder +A [settings.json](../../configuration/configuration-options.mdx#settingsjson) file must reside in each node's `Server` folder and define the server and certificate settings. The server will retrieve this file and use its settings on startup. Read more about RavenDB configuration options [here](../../configuration/configuration-options.mdx). diff --git a/docs/server/security/authorization/security-clearance-and-permissions.mdx b/docs/server/security/authorization/security-clearance-and-permissions.mdx index b0bec6ec14..1e12df432e 100644 --- a/docs/server/security/authorization/security-clearance-and-permissions.mdx +++ b/docs/server/security/authorization/security-clearance-and-permissions.mdx @@ -112,7 +112,7 @@ A `User` certificate with a `Read/Write` access level can perform all operations * [JavaScript static indexes](../../../indexes/javascript-indexes.mdx) are permitted by default with Read/Write User certificates. To configure a server or database so that only Admin certificates will be able to deploy JavaScript static indexes, - set [Indexing.Static.RequireAdminToDeployJavaScriptIndexes](../../../server/configuration/indexing-configuration.mdx#indexing.static.requireadmintodeployjavascriptindexes) + set [Indexing.Static.RequireAdminToDeployJavaScriptIndexes](../../../server/configuration/indexing-configuration.mdx#indexingstaticrequireadmintodeployjavascriptindexes) to `true`. ### `Read Only` diff --git a/docs/server/security/common-errors-and-faq.mdx b/docs/server/security/common-errors-and-faq.mdx index e5ad83daf7..b8159f27b5 100644 --- a/docs/server/security/common-errors-and-faq.mdx +++ b/docs/server/security/common-errors-and-faq.mdx @@ -233,7 +233,7 @@ Learn how to handle this issue [here](../../server/security/authentication/solve * [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-4.2) +* [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 You cannot access Studio using Edge, though during @@ -453,7 +453,7 @@ In PowerShell it can be solved like this: An admin client certificate can be generated through the [RavenDB CLI](../../server/administration/cli#generateclientcert If RavenDB runs as a console application, the CLI is just there. When running as a service, please use the `rvn admin-channel`. Use either the [generateClientCert](../../server/administration/cli.mdx#generateclientcert) command, or (if you already have a certificate) the [trustClientCert](../../server/administration/cli.mdx#trustclientcert) command. -Another way to gain access for an existing certificate is to add the [Security.WellKnownCertificates.Admin](../../server/configuration/security-configuration.mdx#security.wellknowncertificates.admin) configuration to `settings.json` with your existing certificate's thumbprint. +Another way to gain access for an existing certificate is to add the [Security.WellKnownCertificates.Admin](../../server/configuration/security-configuration.mdx#securitywellknowncertificatesadmin) configuration to `settings.json` with your existing certificate's thumbprint. In this case, a server restart is required. ### Certificate is not recognized when setting up on Azure App Services @@ -502,7 +502,7 @@ Treating this as a catastrophic error and aborting the current operation. When encryption is turned on, RavenDB locks memory in order to avoid leaking secrets to disk. Read more [here](../../server/security/encryption/encryption-at-rest.mdx#locking-memory). By default, RavenDB treats this error as catastrophic and will not continue the operation. -You can change this behavior but it's not recommended and should be done only after a proper security analysis is performed, see the [Security Configuration Section](../../server/configuration/security-configuration.mdx#security.donotconsidermemorylockfailureascatastrophicerror). +You can change this behavior but it's not recommended and should be done only after a proper security analysis is performed, see the [Security Configuration Section](../../server/configuration/security-configuration.mdx#securitydonotconsidermemorylockfailureascatastrophicerror). If such a catastrophic error occurs in **Windows**, RavenDB will try to recover automatically by increasing the size of the minimum working set and retrying the operation. In **Linux**, it is the admin's responsibility to configure higher limits manually using: diff --git a/docs/server/security/encryption/database-encryption.mdx b/docs/server/security/encryption/database-encryption.mdx index 2c990ee7d0..d2a8e4789c 100644 --- a/docs/server/security/encryption/database-encryption.mdx +++ b/docs/server/security/encryption/database-encryption.mdx @@ -150,7 +150,7 @@ Database encryption must be enabled when creating the database. If you wish to u Indexing is most efficient when it is performed in the largest transactions possible. However, using encryption is very memory intensive, and if memory runs out before the transaction completes, the entire transaction will fail. To avoid this, you can limit the size of indexing batches in encrypted -databases using [Indexing.Encrypted.TransactionSizeLimitInMb](../../../server/configuration/indexing-configuration.mdx#indexing.encrypted.transactionsizelimitinmb). +databases using [Indexing.Encrypted.TransactionSizeLimitInMb](../../../server/configuration/indexing-configuration.mdx#indexingencryptedtransactionsizelimitinmb). diff --git a/docs/server/security/encryption/encryption-at-rest.mdx b/docs/server/security/encryption/encryption-at-rest.mdx index 45a4a1dedf..5d2a6d34ac 100644 --- a/docs/server/security/encryption/encryption-at-rest.mdx +++ b/docs/server/security/encryption/encryption-at-rest.mdx @@ -45,7 +45,7 @@ request, and when the transaction is finished, modified pages are encrypted and Indexing is most efficient when it is performed in the largest transactions possible. However, using encryption can be very memory intensive, and if memory runs out before the transaction completes, the entire transaction will fail. To avoid this, you can limit the size of indexing batches in encrypted -databases using [Indexing.Encrypted.TransactionSizeLimitInMb](../../../server/configuration/indexing-configuration.mdx#indexing.encrypted.transactionsizelimitinmb). +databases using [Indexing.Encrypted.TransactionSizeLimitInMb](../../../server/configuration/indexing-configuration.mdx#indexingencryptedtransactionsizelimitinmb). The default limit is 64 MB. @@ -64,7 +64,7 @@ However, the memory-mapped files used for **special temporary buffers** (compres We lock the memory regions used by these buffers in order to avoid leaking secrets to disk. This means that if we run out of memory, the OS is not allowed to page these buffers to disk. The downside to this approach is that if we run out of physical RAM RavenDB won't be able to lock memory and will abort the current operation. -You can change this behavior but it's not recommended and should be done only after a proper security analysis is performed, see the [Security Configuration Section](../../../server/configuration/security-configuration.mdx#security.donotconsidermemorylockfailureascatastrophicerror). +You can change this behavior but it's not recommended and should be done only after a proper security analysis is performed, see the [Security Configuration Section](../../../server/configuration/security-configuration.mdx#securitydonotconsidermemorylockfailureascatastrophicerror). If such a catastrophic error occurs in **Windows**, RavenDB will try to recover automatically by increasing the size of the minimum working set and retrying the operation. RavenDB's ability to do this may be limited by the ['increase a process working set' policy setting](https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/increase-a-process-working-set), diff --git a/docs/server/storage/customizing-raven-data-files-locations.mdx b/docs/server/storage/customizing-raven-data-files-locations.mdx index c2cfb45491..8ae84c0444 100644 --- a/docs/server/storage/customizing-raven-data-files-locations.mdx +++ b/docs/server/storage/customizing-raven-data-files-locations.mdx @@ -46,26 +46,26 @@ import LanguageContent from "@site/src/components/LanguageContent"; * __System temporary files__ By default, temporary files containing cluster data and server-wide data are written to the `Temp` folder under the System directory. - Customize the path for these files by setting the [Storage.TempPath](../../server/configuration/storage-configuration.mdx#storage.temppath) configuration option. + Customize the path for these files by setting the [Storage.TempPath](../../server/configuration/storage-configuration.mdx#storagetemppath) configuration option. The temporary files will be written to the combined path `"/System"`. * __Databases temporary files__ By default, all databases' temporary files are written to the `Temp` folder under each Database directory. - Customize the path for these files by setting the [Storage.TempPath](../../server/configuration/storage-configuration.mdx#storage.temppath) configuration option. + Customize the path for these files by setting the [Storage.TempPath](../../server/configuration/storage-configuration.mdx#storagetemppath) configuration option. The temporary files will be written to `"/Databases/{database-name}"`. * __Configuration temporary files__ By default, the configuration temporary files are written to the `Temp` folder under the Configuration directory per database. - Customize the path for these files by setting the [Storage.TempPath](../../server/configuration/storage-configuration.mdx#storage.temppath) configuration option. + Customize the path for these files by setting the [Storage.TempPath](../../server/configuration/storage-configuration.mdx#storagetemppath) configuration option. The temporary files will be written to `"/Databases/{database-name}/Configuration"`. * __Indexes temporary files__ By default, all indexes' temporary files are written to the `Temp` folder under each Index directory. - Customize the path for these files by setting the [Indexing.TempPath](../../server/configuration/indexing-configuration.mdx#indexing.temppath) configuration option. + Customize the path for these files by setting the [Indexing.TempPath](../../server/configuration/indexing-configuration.mdx#indexingtemppath) configuration option. * __Backup temporary files__ By default, backup temporary files are written under the `Database` directory or under `Storage.TempPath` if defined. - Customize the path for these files by setting the [Backup.TempPath](../../server/configuration/backup-configuration.mdx#backup.temppath) configuration option. + Customize the path for these files by setting the [Backup.TempPath](../../server/configuration/backup-configuration.mdx#backuptemppath) configuration option. @@ -137,7 +137,7 @@ ln -s /mnt/FastDrive/Databases/Northwind/Indexes ~/RavenDB/Server/RavenData/Data ## Automate storage definitions -* To help automate the process, we have added the [on directory initialize](../../server/configuration/storage-configuration.mdx#storage.ondirectoryinitialize.exec) configuration option. +* To help automate the process, we have added the [on directory initialize](../../server/configuration/storage-configuration.mdx#storageondirectoryinitializeexec) configuration option. Whenever RavenDB __creates a directory__, it will invoke the process that is defined within that configuration. * The process is called just before the directory is created. @@ -145,7 +145,7 @@ ln -s /mnt/FastDrive/Databases/Northwind/Indexes ~/RavenDB/Server/RavenData/Data * RavenDB will invoke the process with the following params: * Params passed by the user: - * User arguments - optional params, set in the [optional user arguments](../../server/configuration/storage-configuration.mdx#storage.ondirectoryinitialize.exec.arguments) configuration option + * User arguments - optional params, set in the [optional user arguments](../../server/configuration/storage-configuration.mdx#storageondirectoryinitializeexecarguments) configuration option * Params passed by RavenDB: * The environment type (System, Database, Index, Configuration, Compaction) diff --git a/docs/server/storage/documents-compression.mdx b/docs/server/storage/documents-compression.mdx index 30f1bb2b03..410bb0cb14 100644 --- a/docs/server/storage/documents-compression.mdx +++ b/docs/server/storage/documents-compression.mdx @@ -25,7 +25,7 @@ export const supportedLanguages = ["csharp", "nodejs"]; to achieve more efficient data storage with constantly improving compression ratios. * Documents compression can be set for all collections, selected collections, and revisions. - Default compression settings are [configurable](../../server/configuration/database-configuration.mdx#databases.compression.compressallcollectionsdefault). + Default compression settings are [configurable](../../server/configuration/database-configuration.mdx#databasescompressioncompressallcollectionsdefault). * When turned on, compression will be applied to: * **New documents**: @@ -194,7 +194,7 @@ await store.Maintenance.Server.SendAsync(new UpdateDatabaseOperation(dbrecord, d to achieve more efficient data storage with constantly improving compression ratios. * Documents compression can be set for all collections, selected collections, and revisions. - Default compression settings are [configurable](../../server/configuration/database-configuration.mdx#databases.compression.compressallcollectionsdefault). + Default compression settings are [configurable](../../server/configuration/database-configuration.mdx#databasescompressioncompressallcollectionsdefault). * When turned on, compression will be applied to: * **New documents**: diff --git a/docs/server/tcp-compression.mdx b/docs/server/tcp-compression.mdx index 0876ca922b..06e7493040 100644 --- a/docs/server/tcp-compression.mdx +++ b/docs/server/tcp-compression.mdx @@ -88,7 +88,7 @@ No additional configuration is needed to enable this feature. * TCP Compression can also be disabled server-wide, using the - server [Server.Tcp.Compression.Disable](../server/configuration/server-configuration.mdx#server.tcp.compression.disable) configuration. + server [Server.Tcp.Compression.Disable](../server/configuration/server-configuration.mdx#servertcpcompressiondisable) configuration. Learn how to change database settings using Studio [here](../studio/database/settings/database-settings.mdx). diff --git a/docs/server/troubleshooting/collect-info.mdx b/docs/server/troubleshooting/collect-info.mdx index 0d63735b6c..933b905953 100644 --- a/docs/server/troubleshooting/collect-info.mdx +++ b/docs/server/troubleshooting/collect-info.mdx @@ -124,9 +124,9 @@ To preserve your settings after a restart, you can either: ![Save to settings.json](./assets/save-to-settings-json.png) * Or set the relevant configuration key, as described in this [configuration overview](../../server/configuration/configuration-options.mdx): - * For **Server logs**: set the [Logs.MinLevel](../../server/configuration/logs-configuration.mdx#logs.minlevel) configuration key. - * For **Microsoft logs**: set the [Logs.Microsoft.MinLevel](../../server/configuration/logs-configuration.mdx#logs.microsoft.minlevel) configuration key. - * For **Traffic watch logs**: set the [TrafficWatch.Mode](../../server/configuration/traffic-watch-configuration.mdx#trafficwatch.mode) configuration key. + * For **Server logs**: set the [Logs.MinLevel](../../server/configuration/logs-configuration.mdx#logsminlevel) configuration key. + * For **Microsoft logs**: set the [Logs.Microsoft.MinLevel](../../server/configuration/logs-configuration.mdx#logsmicrosoftminlevel) configuration key. + * For **Traffic watch logs**: set the [TrafficWatch.Mode](../../server/configuration/traffic-watch-configuration.mdx#trafficwatchmode) configuration key. @@ -159,11 +159,11 @@ __If the Studio is unavailable__, or if the logs downloaded via the Studio appea then copy the log files directly from the disk to another location to ensure that you keep them, avoiding potential loss due to the retention configuration. -* The location of the log files is determined by the [Logs.Path](../../server/configuration/logs-configuration.mdx#logs.path) configuration. +* The location of the log files is determined by the [Logs.Path](../../server/configuration/logs-configuration.mdx#logspath) configuration. * Logs deletion is controlled by the following configurations: - * [Logs.MaxArchiveDays](../../server/configuration/logs-configuration.mdx#logs.maxarchivedays) - * [Logs.MaxArchiveFiles ](../../server/configuration/logs-configuration.mdx#logs.maxarchivefiles) + * [Logs.MaxArchiveDays](../../server/configuration/logs-configuration.mdx#logsmaxarchivedays) + * [Logs.MaxArchiveFiles ](../../server/configuration/logs-configuration.mdx#logsmaxarchivefiles) diff --git a/docs/server/troubleshooting/logging.mdx b/docs/server/troubleshooting/logging.mdx index c2713a032a..1159d601b9 100644 --- a/docs/server/troubleshooting/logging.mdx +++ b/docs/server/troubleshooting/logging.mdx @@ -86,7 +86,7 @@ is integrated with. * [Using an external configuration file](../../server/troubleshooting/logging.mdx#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#logs.configpath) + 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 @@ -192,11 +192,11 @@ You **will** need to modify these settings, however, if you want to use NLog fea * **Default logging level** The default minimal logging level is `LogLevel.Info`. - To use a different level, set the - [Logs.MinLevel](../../server/configuration/logs-configuration.mdx#logs.minlevel) configuration key. + [Logs.MinLevel](../../server/configuration/logs-configuration.mdx#logsminlevel) configuration key. * **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#logs.path) configuration key. + [Logs.Path](../../server/configuration/logs-configuration.mdx#logspath) configuration key. - [Learn how to log to additional destinations](../../server/troubleshooting/logging.mdx#configuring-and-using-nlog) * **Default time standard** The default time standard used for log entries is `UTC`. @@ -225,7 +225,7 @@ Unlike the permanent customization methods described above (via internal configu keys or an external NLog file), that require a server restart to take effect, changes made using CLI commands will take **immediate effect**. However, they will also be overridden when the server is restarted and the permanent configuration is reloaded from -[settings.json](../../server/configuration/configuration-options.mdx#settings.json) +[settings.json](../../server/configuration/configuration-options.mdx#settingsjson) or the NLog configuration file. Use this syntax to customize logging via CLI: @@ -260,7 +260,7 @@ To use NLog you need to: NLog options are customized using an NLog configuration file. Direct RavenDB to the location of your configuration file using the -[Logs.ConfigPath](../../server/configuration/logs-configuration.mdx#logs.configpath) +[Logs.ConfigPath](../../server/configuration/logs-configuration.mdx#logsconfigpath) configuration key with the file's path as a value. #### Example: To use a configuration file named `NLog.config` that resides in the RavenDB server @@ -291,7 +291,7 @@ through which applications like RavenDB can stream log data to a variety of dest NLog plugins are available as Nuget packages, that we can easily instruct RavenDB to load and run during startup. We do this by defining the plugin Nuget package URL as a property of the -[Logs.NuGet.AdditionalPackages](../../server/configuration/logs-configuration.mdx#logs.nuget.additionalpackages) +[Logs.NuGet.AdditionalPackages](../../server/configuration/logs-configuration.mdx#logsnugetadditionalpackages) configuration key, with the plugin version we want to use as a value. #### Example To load a [Grafana Loki](https://grafana.com/oss/loki/) plugin, for example, @@ -310,11 +310,11 @@ property, with the plugin's version you want to use as a value. -* [Logs.NuGet.PackagesPath](../../server/configuration/logs-configuration.mdx#logs.nuget.packagespath) +* [Logs.NuGet.PackagesPath](../../server/configuration/logs-configuration.mdx#logsnugetpackagespath) Use this key to select the path to which NuGet packages are downloaded. -* [Logs.NuGet.PackageSourceUrl](../../server/configuration/logs-configuration.mdx#logs.nuget.packagesourceurl) +* [Logs.NuGet.PackageSourceUrl](../../server/configuration/logs-configuration.mdx#logsnugetpackagesourceurl) Use this key to set the default location from which NuGet packages are downloaded. -* [Logs.NuGet.AllowPreReleasePackages](../../server/configuration/logs-configuration.mdx#logs.nuget.allowprereleasepackages) +* [Logs.NuGet.AllowPreReleasePackages](../../server/configuration/logs-configuration.mdx#logsnugetallowprereleasepackages) Use this key to determine whether RavenDB is allowed to use pre-release versions of NuGet packages. diff --git a/docs/sharding/overview.mdx b/docs/sharding/overview.mdx index 9a4fcadea5..805c7ece7d 100644 --- a/docs/sharding/overview.mdx +++ b/docs/sharding/overview.mdx @@ -234,7 +234,7 @@ Using a node's local IP address for inter-cluster communications can speed up th Using this method can be particularly helpful in a sharded cluster, where each client request is handled by an orchestrator that may need to communicate with all other shards to process the request and its results. -Use [this configuration option](../server/configuration/core-configuration.mdx#serverurl.cluster) to expose a node's local IP address to other nodes. +Use [this configuration option](../server/configuration/core-configuration.mdx#serverurlcluster) to expose a node's local IP address to other nodes. diff --git a/docs/start/containers/requirements/security.mdx b/docs/start/containers/requirements/security.mdx index 7e2f8e8a5b..6521d1a3ad 100644 --- a/docs/start/containers/requirements/security.mdx +++ b/docs/start/containers/requirements/security.mdx @@ -40,11 +40,11 @@ After getting your cert, start tuning the server to leverage it for security. RavenDB needs to get its server certificate. You can configure its retrieval from one of these origins: - Path - A .pfx certificate stored under a path reachable for a container. - **Security.Certificate.Path** configuration option value defines the path. [Security Configuration - Security.Certificate.Path](../../../server/configuration/security-configuration.mdx#security.certificate.path) + **Security.Certificate.Path** configuration option value defines the path. [Security Configuration - Security.Certificate.Path](../../../server/configuration/security-configuration.mdx#securitycertificatepath) - Script - A script that returns your certificate by any means. You can obtain it from container environmental variables, secured vault, secret, etc. - **Security.Certificate.Load.Exec** configuration option value defines the script path. [Security Configuration - Security.Certificate.Load.Exec](../../../server/configuration/security-configuration.mdx#security.certificate.load.exec) + **Security.Certificate.Load.Exec** configuration option value defines the script path. [Security Configuration - Security.Certificate.Load.Exec](../../../server/configuration/security-configuration.mdx#securitycertificateloadexec) These configuration options can be passed to RavenDB by settings.json, environmental variables, or command line arguments. See more here: [Configuration Options](../../../server/configuration/configuration-options.mdx) @@ -60,14 +60,14 @@ To enable it, set `Setup.Mode` configuration option to `LetsEncrypt`. Be aware that this automation will work **only when using Setup Wizard to obtain the LetsEncrypt certificate**, as RavenDB doesn't control your domain nor can access your backend used in the certificate load script. To learn more about this, visit this site: [RavenDB Lets Encrypt Certificates Docs](../../../server/security/authentication/lets-encrypt-certificates.mdx) -You can learn about different `Raven.SetupMode` values here: [Core Configuration - Setup.Mode](../../../server/configuration/core-configuration.mdx#setup.mode) +You can learn about different `Raven.SetupMode` values here: [Core Configuration - Setup.Mode](../../../server/configuration/core-configuration.mdx#setupmode) Also, you need to provide us with an email that you will use for the Let's Encrypt matter. Use `Security.Certificate.LetsEncrypt.Email`. #### Manual To configure manual certificate replacement and updates, write scripts to supply RavenDB configuration: -- [Security.Certificate.Renew.Exec](../../../server/configuration/security-configuration.mdx#security.certificate.renew.exec) -- [Security.Certificate.Change.Exec](../../../server/configuration/security-configuration.mdx#security.certificate.change.exec) +- [Security.Certificate.Renew.Exec](../../../server/configuration/security-configuration.mdx#securitycertificaterenewexec) +- [Security.Certificate.Change.Exec](../../../server/configuration/security-configuration.mdx#securitycertificatechangeexec) It will allow RavenDB to execute your routines, which should: diff --git a/docs/start/getting-started.mdx b/docs/start/getting-started.mdx index d53700322d..80754e0173 100644 --- a/docs/start/getting-started.mdx +++ b/docs/start/getting-started.mdx @@ -146,7 +146,7 @@ appearing: ### Configuration -The RavenDB server uses a [settings.json](../server/configuration/configuration-options.mdx#settings.json) file in each node `Server` folder to store the server-wide configuration options. +The RavenDB server uses a [settings.json](../server/configuration/configuration-options.mdx#settingsjson) file in each node `Server` folder to store the server-wide configuration options. When starting a server, RavenDB will look for the `settings.json` file in the node `Server` folder, so it must be located there. The [Setup Wizard](../start/installation/setup-wizard.mdx) places it correctly automatically. @@ -190,9 +190,9 @@ For a list of IPs and ports already in use, run `netstat -a` in the command line RavenDB requires write permissions to the following locations: -- The folder where RavenDB server is running (to update [settings.json](../server/configuration/configuration-options.mdx#settings.json) by the [Setup Wizard](../start/installation/setup-wizard.mdx)) +- The folder where RavenDB server is running (to update [settings.json](../server/configuration/configuration-options.mdx#settingsjson) by the [Setup Wizard](../start/installation/setup-wizard.mdx)) - The data folder ([`DataDir`](../server/configuration/core-configuration.mdx#datadir) setting) -- The logs folder ([`Logs.Path`](../server/configuration/logs-configuration.mdx#logs.path) setting) +- The logs folder ([`Logs.Path`](../server/configuration/logs-configuration.mdx#logspath) setting) If you intend to run as a service, the write permissions should be granted to the user running the service (e.g. "Local Service"). diff --git a/docs/start/installation/deployment-considerations.mdx b/docs/start/installation/deployment-considerations.mdx index 3b858f8919..8942c27bcd 100644 --- a/docs/start/installation/deployment-considerations.mdx +++ b/docs/start/installation/deployment-considerations.mdx @@ -100,7 +100,7 @@ permissions to the RavenDB directory and to the specified data directory. You ca On Linux, you'll typically run RavenDB as a daemon. The `install-daemon.sh` can handle the daemon registration for you (Ubuntu only). -In either case, you can configure RavenDB using the [settings.json](../../server/configuration/configuration-options.mdx#settings.json) file. The most important configurations are the data directory and the +In either case, you can configure RavenDB using the [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) file. The most important configurations are the data directory and the IPs and ports RavenDB will listen to. It is recommended that you'll pick the fastest drives for RavenDB's data directory, while the binaries for RavenDB can reside anywhere in the system. diff --git a/docs/start/installation/manual.mdx b/docs/start/installation/manual.mdx index bbb358cfbb..ba3894b45a 100644 --- a/docs/start/installation/manual.mdx +++ b/docs/start/installation/manual.mdx @@ -42,7 +42,7 @@ We recommend using multiple machines to improve [cluster availability via failov By default, when a server is started using `run.ps1` (or `run.sh` in Linux) script. It will open a browser with a [Setup Wizard](../../start/installation/setup-wizard.mdx) which will guide you through the server configuration process. -The setup is started because the default configuration file [settings.json](../../server/configuration/configuration-options.mdx#settings.json) (found in the downloaded RavenDB Server package inside the **Server** folder) comes configured like this: +The setup is started because the default configuration file [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) (found in the downloaded RavenDB Server package inside the **Server** folder) comes configured like this: @@ -93,5 +93,5 @@ Read the [Manual Certificate Configuration](../../server/security/authentication ## Configuration -Read the [Configuration Section](../../server/configuration/configuration-options.mdx) to learn more about using [settings.json](../../server/configuration/configuration-options.mdx#settings.json) and see a list of configuration options. +Read the [Configuration Section](../../server/configuration/configuration-options.mdx) to learn more about using [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) and see a list of configuration options. diff --git a/docs/start/installation/setup-examples/aws-linux-vm.mdx b/docs/start/installation/setup-examples/aws-linux-vm.mdx index 1f9dbc372b..6faa8e41a9 100644 --- a/docs/start/installation/setup-examples/aws-linux-vm.mdx +++ b/docs/start/installation/setup-examples/aws-linux-vm.mdx @@ -132,7 +132,7 @@ Locate the VM's private and public IP addresses in the AWS EC2 Management Consol You have a few choices on how to run the RavenDB server. We will use the [Setup Wizard](../../../start/installation/setup-wizard.mdx), but you can also configure things [manually](../../../start/installation/manual.mdx). -Let's edit the [settings.json](../../../server/configuration/configuration-options.mdx#settings.json) file so that we can perform the setup remotely using the browser. +Let's edit the [settings.json](../../../server/configuration/configuration-options.mdx#settingsjson) file so that we can perform the setup remotely using the browser. Notice that when we run the server for the first time, `settings.json` is created from `settings.default.json`. So if `settings.json` doesn't exist, edit `settings.default.json` instead. @@ -236,7 +236,7 @@ Access the certificate view to see both the loaded server certificate and the ad Congratulations! You have a secure RavenDB server running on a simple EC2 machine. -Don't forget to delete the `Security.UnsecuredAccessAllowed` property from [settings.json](../../../server/configuration/configuration-options.mdx#settings.json). It's not necessary anymore because access to the server now requires using a registered client certificate. +Don't forget to delete the `Security.UnsecuredAccessAllowed` property from [settings.json](../../../server/configuration/configuration-options.mdx#settingsjson). It's not necessary anymore because access to the server now requires using a registered client certificate. Connecting a few servers in a cluster is easy. Follow [these instructions](../../../start/installation/setup-wizard.mdx) to construct a cluster during setup. diff --git a/docs/start/installation/setup-wizard.mdx b/docs/start/installation/setup-wizard.mdx index 4b8fc9832a..615c4a4953 100644 --- a/docs/start/installation/setup-wizard.mdx +++ b/docs/start/installation/setup-wizard.mdx @@ -148,7 +148,7 @@ All 3 nodes will run on the local machine: - Node B (https://b.raven.development.run) will listen to 127.0.0.2 on port 8080. - Node C (https://c.raven.development.run) will listen to 127.0.0.3 on port 8080. -Each node will run in its own process and have its own data directory and [settings.json](../../server/configuration/configuration-options.mdx#settings.json) file. +Each node will run in its own process and have its own data directory and [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) file. You should have 3 separate RavenDB node folders. ### Example II - On separate machines for higher availability @@ -423,7 +423,7 @@ All 3 nodes will run on the local machine: - Node B (https://b.ravendb.example.com) will listen to 127.0.0.2 on port 8080. - Node C (https://c.ravendb.example.com) will listen to 127.0.0.3 on port 8080. -Each node will run in its own process and have its own data directory and [settings.json](../../server/configuration/configuration-options.mdx#settings.json) file. +Each node will run in its own process and have its own data directory and [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) file. ### Example II - On separate machines diff --git a/docs/start/installation/upgrading-to-new-version.mdx b/docs/start/installation/upgrading-to-new-version.mdx index 87dcbbb78c..4b53fe4cd7 100644 --- a/docs/start/installation/upgrading-to-new-version.mdx +++ b/docs/start/installation/upgrading-to-new-version.mdx @@ -30,7 +30,7 @@ Upgrading a RavenDB instance to a new version is very simple. To do so: 3. Remove old RavenDB binaries * **Avoid** deleting your actual data, contained in folders like `RavenData`. - * **Avoid** overwriting your configuration files, e.g. [settings.json](../../server/configuration/configuration-options.mdx#settings.json). + * **Avoid** overwriting your configuration files, e.g. [settings.json](../../server/configuration/configuration-options.mdx#settingsjson). * **Avoid** deleting your certificate file (ending with `.pfx` or `.pem`). * For additional information see the [certificate page](../../server/security/authentication/certificate-configuration.mdx). * These steps are strictly necessary when updating to version 5.1. @@ -71,7 +71,7 @@ or [External replication](../../studio/database/tasks/ongoing-tasks/external-rep Please read the [migration article](../../migration/server/data-migration.mdx) for additional data and client migration strategies. * If you have a license for a RavenDB version older than `6.x`, upgrading to version `6.0` will require you to upgrade your license key. - * Read [here](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6.x) how to upgrade + * Read [here](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6x) how to upgrade and replace your existing license key. * Read [here](../../migration/server/data-migration.mdx) about migrating from one RavenDB version to another. diff --git a/docs/start/licensing/activate-license.mdx b/docs/start/licensing/activate-license.mdx index 9233c49897..211a51235b 100644 --- a/docs/start/licensing/activate-license.mdx +++ b/docs/start/licensing/activate-license.mdx @@ -30,7 +30,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * You can activate the license using either one of the following configuration keys: * [License](../../server/configuration/license-configuration.mdx#license) - * [License.Path](../../server/configuration/license-configuration.mdx#license.path) + * [License.Path](../../server/configuration/license-configuration.mdx#licensepath) * These configuration keys can be set in _setting.json_ or as environment variables. Learn more in [configuration overview](../../server/configuration/configuration-options.mdx). diff --git a/docs/start/licensing/force-update.mdx b/docs/start/licensing/force-update.mdx index 50f5eb785b..b9e03e3070 100644 --- a/docs/start/licensing/force-update.mdx +++ b/docs/start/licensing/force-update.mdx @@ -21,7 +21,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * This automatic update will be applied provided that: * You have an active connection to RavenDB's License Server (api.ravendb.net). - * [DisableAutoUpdate](../../server/configuration/license-configuration.mdx#license.disableautoupdate) is set to false. + * [DisableAutoUpdate](../../server/configuration/license-configuration.mdx#licensedisableautoupdate) is set to false. * If changes were made to your current license and you want to **apply immediately**, then you can **force the update from Studio**. @@ -43,7 +43,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Click the _Force Update_ button. This will update your current license immediately. - * If [DisableAutoUpdateFromApi](../../server/configuration/license-configuration.mdx#license.disableautoupdatefromapi) is set to _true_, + * If [DisableAutoUpdateFromApi](../../server/configuration/license-configuration.mdx#licensedisableautoupdatefromapi) is set to _true_, the license will be updated from the [configuration keys](../../start/licensing/activate-license.mdx#activate-license-with-configuration-keys). If set to _false_, the license will be updated from the [License Server](../../start/licensing/licensing-overview.mdx#license-server), provided you have an active connection. diff --git a/docs/start/licensing/renew-license.mdx b/docs/start/licensing/renew-license.mdx index 26e584a50b..2f7da0cd33 100644 --- a/docs/start/licensing/renew-license.mdx +++ b/docs/start/licensing/renew-license.mdx @@ -34,7 +34,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; **Automatic renewal**: If your server has an active connection to RavenDB's [License Server](../../start/licensing/licensing-overview.mdx#license-server), -and if the [DisableAutoUpdate](../../server/configuration/license-configuration.mdx#license.disableautoupdate) configuration is Not set to true, +and if the [DisableAutoUpdate](../../server/configuration/license-configuration.mdx#licensedisableautoupdate) configuration is Not set to true, then these commercial licenses will be automatically renewed. @@ -50,7 +50,7 @@ Copy the new license key from the mail and proceed with one of the following opt **Or**: -* Set [DisableAutoUpdateFromApi](../../server/configuration/license-configuration.mdx#license.disableautoupdatefromapi) to true. +* Set [DisableAutoUpdateFromApi](../../server/configuration/license-configuration.mdx#licensedisableautoupdatefromapi) to true. * Activate the new license key using the [configuration keys](../../start/licensing/activate-license.mdx#activate-license-with-configuration-keys). diff --git a/docs/start/licensing/replace-license.mdx b/docs/start/licensing/replace-license.mdx index 8176427693..d57625f066 100644 --- a/docs/start/licensing/replace-license.mdx +++ b/docs/start/licensing/replace-license.mdx @@ -22,13 +22,13 @@ 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-6.x) + as explained [below](../../start/licensing/replace-license.mdx#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) * [Maintain auto-renewal of Let's Encrypt certificates](../../start/licensing/replace-license.mdx#maintain-auto-renewal-of-let) - * [Upgrade a License Key For RavenDB 6.x](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6.x) + * [Upgrade a License Key For RavenDB 6.x](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6x) ## Replace license from Studio diff --git a/docs/studio/database/create-new-database/from-backup.mdx b/docs/studio/database/create-new-database/from-backup.mdx index c121451f55..00cd20edfb 100644 --- a/docs/studio/database/create-new-database/from-backup.mdx +++ b/docs/studio/database/create-new-database/from-backup.mdx @@ -49,7 +49,7 @@ Another way to access the New Database From Backup interface is via the Studio B ![Figure 2. Backup Source Configuration](./assets/new-database-from-backup-2.png) -1. [**Name** your new database](../../../studio/database/create-new-database/general-flow.mdx#2.-database-name). +1. [**Name** your new database](../../../studio/database/create-new-database/general-flow.mdx#2-database-name). 2. **Source** Select the source server type to see the fields necessary to access the backup 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 44408be261..3ee0677ebc 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](../../../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 @@ -35,7 +35,7 @@ Open the down arrow and click `New database from legacy files`. ![Figure 2. Create New Database From Legacy Files - Data Source Configuration](./assets/new-database-from-legacy-2.png) -1. [Database Name](../../../studio/database/create-new-database/general-flow.mdx#2.-database-name) +1. [Database Name](../../../studio/database/create-new-database/general-flow.mdx#2-database-name) 2. **Resource type** * RavenFS files will be saved as documents with attachments in @files collection. diff --git a/docs/studio/database/create-new-database/general-flow.mdx b/docs/studio/database/create-new-database/general-flow.mdx index c7727ebcbd..de1fcc3b13 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 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](../../../studio/database/create-new-database/general-flow.mdx#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). @@ -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](../../../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 diff --git a/docs/studio/database/documents/patch-view.mdx b/docs/studio/database/documents/patch-view.mdx index d6a0caaf2a..8eaa43b152 100644 --- a/docs/studio/database/documents/patch-view.mdx +++ b/docs/studio/database/documents/patch-view.mdx @@ -124,7 +124,7 @@ update \{ * d. **Ignore maximum number of steps for script** By default, a patch script can execute up to a maximum number of steps before throwing an exception. - This limit is set by the [Patching.MaxStepsForScript](../../../server/configuration/patching-configuration.mdx#patching.maxstepsforscript) configuration key (default: 10,000). + This limit is set by the [Patching.MaxStepsForScript](../../../server/configuration/patching-configuration.mdx#patchingmaxstepsforscript) configuration key (default: 10,000). Toggle this option ON to ignore the limit. * e. **Limit number of operations** diff --git a/docs/studio/database/indexes/indexing-performance.mdx b/docs/studio/database/indexes/indexing-performance.mdx index e7d769edf0..534ac5240a 100644 --- a/docs/studio/database/indexes/indexing-performance.mdx +++ b/docs/studio/database/indexes/indexing-performance.mdx @@ -171,7 +171,7 @@ Indexing can be a taxing operation on CPU resources. There are a number of [configurations](../../../server/configuration/indexing-configuration.mdx) that efficiently use batch stops to break up huge batch processes into smaller batches to prevent exhausting resources. If a configuration is specific to an index, it can be [set in the Studio](../../../studio/database/indexes/create-map-index.mdx#configuration). -If it is a server-wide only configuration, it must be set in the server's [settings.json](../../../server/configuration/configuration-options.mdx#settings.json). +If it is a server-wide only configuration, it must be set in the server's [settings.json](../../../server/configuration/configuration-options.mdx#settingsjson). While they prevent system exhaustion, batch stops also point to potential **opportunities to optimize** your indexes. @@ -188,18 +188,18 @@ Some indexes are responsible for a huge dataset and/or have very complex, demand 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: -- [Indexing.MapTimeoutInSec](../../../server/configuration/indexing-configuration.mdx#indexing.maptimeoutinsec) +- [Indexing.MapTimeoutInSec](../../../server/configuration/indexing-configuration.mdx#indexingmaptimeoutinsec) Number of seconds after which mapping will end even if there is more to map. -- [Indexing.MapTimeoutAfterEtagReachedInMin](../../../server/configuration/indexing-configuration.mdx#indexing.maptimeoutafteretagreachedinmin) +- [Indexing.MapTimeoutAfterEtagReachedInMin](../../../server/configuration/indexing-configuration.mdx#indexingmaptimeoutafteretagreachedinmin) This will only be applied if we pass the last [etag](../../../glossary/etag.mdx) in collection that we saw when batch was started. -- [Indexing.MapBatchSize](../../../server/configuration/indexing-configuration.mdx#indexing.mapbatchsize) +- [Indexing.MapBatchSize](../../../server/configuration/indexing-configuration.mdx#indexingmapbatchsize) Maximum number of documents to be processed by the index per indexing batch. #### Low Memory -* [Low Memory](../../../server/configuration/memory-configuration.mdx#memory.lowmemorylimitinmb) 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](../../../studio/database/indexes/indexing-performance.mdx#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#indexing.mapbatchsize) that you can configure + * Until then, there are a number of [indexing configurations](../../../server/configuration/indexing-configuration.mdx#indexingmapbatchsize) that you can configure to break up processes into smaller batches. * **Cloud server** Your indexing process will continue until it is finished, but will be broken up into smaller batches and continue when enough CPU credits accumulate. @@ -213,7 +213,7 @@ You can configure [batch stops](../../../studio/database/indexes/indexing-perfor [externally replicate](../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx) to new instances, and/or optimize your indexes. #### Concurrent Processing of Too Many Indexes -- [Limit concurrent index processes](../../../server/configuration/indexing-configuration.mdx#indexing.maxnumberofconcurrentlyrunningindexes) - +- [Limit concurrent index processes](../../../server/configuration/indexing-configuration.mdx#indexingmaxnumberofconcurrentlyrunningindexes) - RavenDB can handle multiple index processes at the same time, but if there are too many, it will exhaust the system resources and cause a noticeable slow-down. The `Indexing.MaxNumberOfConcurrentlyRunningIndexes` method enables you to have many indexes without exhausting resources by allowing you to set the number of concurrent index processes. diff --git a/docs/studio/database/settings/database-settings.mdx b/docs/studio/database/settings/database-settings.mdx index bb1d986fe6..72f050e5af 100644 --- a/docs/studio/database/settings/database-settings.mdx +++ b/docs/studio/database/settings/database-settings.mdx @@ -57,7 +57,7 @@ Do not modify the database settings unless you are an expert and know what you'r * Only the **database scope** configuration keys can be edited from this view. Configuration keys that relate only to the **server scope** are edited in the - [`settings.json` file](../../../server/configuration/configuration-options.mdx#settings.json) + [`settings.json` file](../../../server/configuration/configuration-options.mdx#settingsjson) and can only be viewed here. * Once you save the changes made in this view, all modifications are saved into the @@ -73,7 +73,7 @@ Do not modify the database settings unless you are an expert and know what you'r 3. This column lists the **Configuration Keys** in the selected Category. 4. This column lists the current **Value** set for the key. 5. The lock icon indicates that this key is server scoped and can not be modified here. - It can be edited only from the [`settings.json` file](../../../server/configuration/configuration-options.mdx#settings.json) + It can be edited only from the [`settings.json` file](../../../server/configuration/configuration-options.mdx#settingsjson) located in your RavenDB executable folder. 6. Toggle to override the current value of this key. 7. Use the edit box to customize the value. diff --git a/docs/studio/database/settings/documents-compression.mdx b/docs/studio/database/settings/documents-compression.mdx index 050160aea3..441a93e869 100644 --- a/docs/studio/database/settings/documents-compression.mdx +++ b/docs/studio/database/settings/documents-compression.mdx @@ -20,7 +20,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Learn more in this [overview](../../../server/storage/documents-compression.mdx#overview). * Documents compression can be set for all collections, selected collections, and revisions. - Default compression settings are [configurable](../../../server/configuration/database-configuration.mdx#databases.compression.compressallcollectionsdefault). + Default compression settings are [configurable](../../../server/configuration/database-configuration.mdx#databasescompressioncompressallcollectionsdefault). * When turned on, compression will be applied to: * **New documents**: diff --git a/docs/studio/database/settings/studio-configuration.mdx b/docs/studio/database/settings/studio-configuration.mdx index c528fd6ec7..dd203aa8e7 100644 --- a/docs/studio/database/settings/studio-configuration.mdx +++ b/docs/studio/database/settings/studio-configuration.mdx @@ -18,9 +18,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * The Studio Configuration view enables configuration of studio-related operations and interfaces. * Settings changed in this view do not change configurations in other scopes such as Client or Server API. - * To disable the creation of Auto-Indexes in other scopes, set [Indexing.DisableQueryOptimizerGeneratedIndexes](../../../server/configuration/indexing-configuration.mdx#indexing.disablequeryoptimizergeneratedindexes) + * To disable the creation of Auto-Indexes in other scopes, set [Indexing.DisableQueryOptimizerGeneratedIndexes](../../../server/configuration/indexing-configuration.mdx#indexingdisablequeryoptimizergeneratedindexes) to `true`: - * Server-wide - set it in the server's [settings.json](../../../server/configuration/configuration-options.mdx#settings.json) file. + * Server-wide - set it in the server's [settings.json](../../../server/configuration/configuration-options.mdx#settingsjson) file. * Per database - set it in the database's [Document Store](../../../client-api/operations/maintenance/configuration/database-settings-operation.mdx). In this page: @@ -88,9 +88,9 @@ In this page: * Note: dynamic queries can be issued either when [querying](../../../studio/database/queries/query-view.mdx#query-view) or when [patching](../../../studio/database/documents/patch-view.mdx#patch-configuration). * Auto-indexes are dynamically maintained to change automatically in response to changing query demands. - After a certain amount of time that an auto-index is not used [(30 minutes by default)](../../../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforemarkingautoindexasidleinmin), + After a certain amount of time that an auto-index is not used [(30 minutes by default)](../../../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforemarkingautoindexasidleinmin), the index goes into an [idle state](../../../studio/database/indexes/indexes-list-view.mdx#index-state) - and deleted after a set time-period [(72 hours by default)](../../../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforedeletingautoindexmarkedasidleinhrs). + and deleted after a set time-period [(72 hours by default)](../../../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforedeletingautoindexmarkedasidleinhrs). * To provide for fast queries, indexes process information in the background. If they are processing large datasets, each index can be demanding on I/O resources. @@ -114,7 +114,7 @@ temporarily allow Auto-Index in the Query or Patch settings interface. Note: These settings only affect Auto-Indexing as a result of Queries or Patches done in the Studio. They do not affect API-based Queries or Patches. -To configure API-based Auto-Indexing, see [Indexing.DisableQueryOptimizerGeneratedIndexes](../../../server/configuration/indexing-configuration.mdx#indexing.disablequeryoptimizergeneratedindexes) +To configure API-based Auto-Indexing, see [Indexing.DisableQueryOptimizerGeneratedIndexes](../../../server/configuration/indexing-configuration.mdx#indexingdisablequeryoptimizergeneratedindexes) @@ -132,7 +132,7 @@ To configure API-based Auto-Indexing, see [Indexing.DisableQueryOptimizerGenerat Choose work environment. This does not affect settings or features. It makes it clear if, for example, you are in a production server and should be much more careful than in a development environment. 4. **Default replication factor** - Change the default [replication factor](../../../studio/database/create-new-database/general-flow.mdx#3.-configure-replication) from + Change the default [replication factor](../../../studio/database/create-new-database/general-flow.mdx#3-configure-replication) from automatically replicating data to every node in the cluster. 5. **Help us improve the Studio** Allow the Studio to send usage statistics to inform our developers. diff --git a/docs/studio/database/tasks/create-sample-data.mdx b/docs/studio/database/tasks/create-sample-data.mdx index 127346a8f8..84819a1b63 100644 --- a/docs/studio/database/tasks/create-sample-data.mdx +++ b/docs/studio/database/tasks/create-sample-data.mdx @@ -34,7 +34,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * To create sample data, you can either empty your playground database or [create a new database](../../../studio/database/create-new-database/general-flow.mdx). -* If you plan to use [multiple nodes](../../../studio/database/create-new-database/general-flow.mdx#3.-configure-replication) +* If you plan to use [multiple nodes](../../../studio/database/create-new-database/general-flow.mdx#3-configure-replication) and/or [encryption](../../../studio/database/create-new-database/encrypted.mdx) in production, we recommend installing your playground database in a similar environment. 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 e8ddbd8f2c..8a333adac3 100644 --- a/docs/studio/database/tasks/import-data/import-from-other.mdx +++ b/docs/studio/database/tasks/import-data/import-from-other.mdx @@ -25,7 +25,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Download Raven.Migrator Tool](../../../../studio/database/tasks/import-data/import-from-other.mdx#download-raven.migrator-tool) + * [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) @@ -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-raven.migrator-tool). + * Find `Raven.Migrator.exe` in the [tools package](../../../../studio/database/tasks/import-data/import-from-other.mdx#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-raven.migrator-tool). + * Find `Raven.Migrator.exe` in the [tools package](../../../../studio/database/tasks/import-data/import-from-other.mdx#download-ravenmigrator-tool). * Provide a path to `Raven.Migrator.exe`'s folder. 2. **Database Source** diff --git a/docs/studio/server/certificates/server-management-certificates-view.mdx b/docs/studio/server/certificates/server-management-certificates-view.mdx index 01edc5b42d..14e7642e01 100644 --- a/docs/studio/server/certificates/server-management-certificates-view.mdx +++ b/docs/studio/server/certificates/server-management-certificates-view.mdx @@ -44,7 +44,7 @@ the permissions entirely using this view. * [Export server certificates](../../../server/security/authentication/certificate-management.mdx#export-server-certificates) so that you can import them into another server. * [Replace server certificates](../../../server/security/authentication/certificate-renewal-and-rotation.mdx) by uploading another `.pfx` certificate. 5. **Well known admin certificate** - This is a trusted certificate, [defined by a system administrator](../../../server/configuration/security-configuration.mdx#security.wellknowncertificates.admin) + This is a trusted certificate, [defined by a system administrator](../../../server/configuration/security-configuration.mdx#securitywellknowncertificatesadmin) and given admin permissions. 6. **Server certificate** You can click [Renew now](../../../server/security/authentication/certificate-renewal-and-rotation.mdx) here. diff --git a/docs/studio/server/server-settings.mdx b/docs/studio/server/server-settings.mdx index 1bf4ef1d58..8f566ba1fd 100644 --- a/docs/studio/server/server-settings.mdx +++ b/docs/studio/server/server-settings.mdx @@ -19,7 +19,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; hosted by the server. * This is a **read-only** view, showing settings made using [environment variables](../../server/configuration/configuration-options.mdx#environment-variables), - the [settings.json](../../server/configuration/configuration-options.mdx#settings.json) + the [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) configuration file, and [command line arguments](../../server/configuration/configuration-options.mdx#command-line-arguments). * For the server settings view open **Manage Server** `>>` **Server Settings** * To modify the settings of individual databases use the [Database Settings](../../studio/database/settings/database-settings.mdx) view. diff --git a/versioned_docs/version-6.2/client-api/changes/what-is-changes-api.mdx b/versioned_docs/version-6.2/client-api/changes/what-is-changes-api.mdx index 8e9a9aa5df..588f87a629 100644 --- a/versioned_docs/version-6.2/client-api/changes/what-is-changes-api.mdx +++ b/versioned_docs/version-6.2/client-api/changes/what-is-changes-api.mdx @@ -183,7 +183,7 @@ finally #### Changes API and Database Timeout One or more open Changes API connections will prevent a database from becoming -idle and unloaded, regardless of [the configuration value for database idle timeout](../../server/configuration/database-configuration.mdx#databases.maxidletimeinsec). +idle and unloaded, regardless of [the configuration value for database idle timeout](../../server/configuration/database-configuration.mdx#databasesmaxidletimeinsec). #### Changes API and Method Overloads @@ -343,7 +343,7 @@ try \{ One or more open Changes API connections will prevent a database from becoming -idle and unloaded, regardless of [the configuration value for database idle timeout](../../server/configuration/database-configuration.mdx#databases.maxidletimeinsec). +idle and unloaded, regardless of [the configuration value for database idle timeout](../../server/configuration/database-configuration.mdx#databasesmaxidletimeinsec). @@ -492,7 +492,7 @@ try \{ #### Changes API and Database Timeout One or more open Changes API connections will prevent a database from becoming -idle and unloaded, regardless of [the configuration value for database idle timeout](../../server/configuration/database-configuration.mdx#databases.maxidletimeinsec). +idle and unloaded, regardless of [the configuration value for database idle timeout](../../server/configuration/database-configuration.mdx#databasesmaxidletimeinsec). #### Changes API and Method Overloads diff --git a/versioned_docs/version-6.2/client-api/configuration/conventions.mdx b/versioned_docs/version-6.2/client-api/configuration/conventions.mdx index a3e71443d3..acf0f527b2 100644 --- a/versioned_docs/version-6.2/client-api/configuration/conventions.mdx +++ b/versioned_docs/version-6.2/client-api/configuration/conventions.mdx @@ -28,8 +28,8 @@ export const supportedLanguages = ["csharp", "nodejs"]; * [How to set conventions](../../client-api/configuration/conventions.mdx#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#aggressivecache.duration) - [AggressiveCache.Mode](../../client-api/configuration/conventions.mdx#aggressivecache.mode) + [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) diff --git a/versioned_docs/version-6.2/client-api/configuration/serialization.mdx b/versioned_docs/version-6.2/client-api/configuration/serialization.mdx index 08ae36a0ae..9e723ea7a3 100644 --- a/versioned_docs/version-6.2/client-api/configuration/serialization.mdx +++ b/versioned_docs/version-6.2/client-api/configuration/serialization.mdx @@ -27,7 +27,7 @@ by which entities are serialized as they are sent by the client to the server. * In this page: * [CustomizeJsonSerializer](../../client-api/configuration/serialization.mdx#customizejsonserializer) * [JsonContractResolver](../../client-api/configuration/serialization.mdx#jsoncontractresolver) - * [BulkInsert.TrySerializeEntityToJsonStream](../../client-api/configuration/serialization.mdx#bulkinsert.tryserializeentitytojsonstream) + * [BulkInsert.TrySerializeEntityToJsonStream](../../client-api/configuration/serialization.mdx#bulkinserttryserializeentitytojsonstream) * [IgnoreByRefMembers and IgnoreUnsafeMembers](../../client-api/configuration/serialization.mdx#ignorebyrefmembers-and-ignoreunsafemembers) diff --git a/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/api-overview.mdx b/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/api-overview.mdx index 9e6dc1290f..276946a9b6 100644 --- a/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/api-overview.mdx +++ b/versioned_docs/version-6.2/client-api/data-subscriptions/consumption/api-overview.mdx @@ -26,7 +26,7 @@ export const supportedLanguages = ["csharp", "java", "python", "nodejs"]; * [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>) - * [SubscriptionBatch<T>.Item](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatch<t>.item) + * [SubscriptionBatch<T>.Item](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatch<t>item) * [SubscriptionWorker<T>](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworker<t>) @@ -160,7 +160,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#subscriptionbatch<t>.item) below. | +| **Items** | `List.Item>` | List of items in the batch.
See [SubscriptionBatch<T>.Item](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatch<t>item) below. | | **NumberOfItemsInBatch** | `int` | Number of items in the batch. | | Method Signature | Return value | Description | 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 617ccc77b4..a9f841bd0d 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 @@ -23,11 +23,11 @@ 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-4.1) - * [Compatibility - RavenDB 4.2 and Higher](../../client-api/faq/backward-compatibility.mdx#compatibility---ravendb-4.2-and-higher) + * [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-4.1) - * [Upgrading - RavenDB 4.2 and Higher](../../client-api/faq/backward-compatibility.mdx#upgrading---ravendb-4.2-and-higher) + * [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) @@ -81,7 +81,7 @@ page to learn more about migrating from early versions. ### 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#ravendb-4.2-and-higher-compatibility). +are [compatible with servers of versions higher than theirs](../../client-api/faq/backward-compatibility.mdx#ravendb-42-and-higher-compatibility). ### 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/operations/common/delete-by-query.mdx b/versioned_docs/version-6.2/client-api/operations/common/delete-by-query.mdx index a8e114889d..d33d92b86a 100644 --- a/versioned_docs/version-6.2/client-api/operations/common/delete-by-query.mdx +++ b/versioned_docs/version-6.2/client-api/operations/common/delete-by-query.mdx @@ -40,7 +40,7 @@ export const supportedLanguages = ["csharp", "java", "python", "php", "nodejs"]; * To avoid issues when recreating such documents using a cluster-wide session, see [Best practice when storing a document](../../../client-api/session/cluster-transaction/atomic-guards.mdx#best-practice-when-storing-a-document-in-a-cluster-wide-transaction). * 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). + 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) @@ -551,7 +551,7 @@ so it can happen than a document has been updated or deleted meanwhile. * To avoid issues when recreating such documents using a cluster-wide session, see [Best practice when storing a document](../../../client-api/session/cluster-transaction/atomic-guards.mdx#best-practice-when-storing-a-document-in-a-cluster-wide-transaction). * 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). + 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) @@ -754,7 +754,7 @@ document_id_that_was_deleted = details[0]["Id"] * To avoid issues when recreating such documents using a cluster-wide session, see [Best practice when storing a document](../../../client-api/session/cluster-transaction/atomic-guards.mdx#best-practice-when-storing-a-document-in-a-cluster-wide-transaction). * 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). + 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) @@ -1046,7 +1046,7 @@ $documentIdThatWasDeleted = $details[0]->getId(); * To avoid issues when recreating such documents using a cluster-wide session, see [Best practice when storing a document](../../../client-api/session/cluster-transaction/atomic-guards.mdx#best-practice-when-storing-a-document-in-a-cluster-wide-transaction). * 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). + 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) diff --git a/versioned_docs/version-6.2/client-api/operations/compare-exchange/include-compare-exchange.mdx b/versioned_docs/version-6.2/client-api/operations/compare-exchange/include-compare-exchange.mdx index d74440f32a..83cb0d9486 100644 --- a/versioned_docs/version-6.2/client-api/operations/compare-exchange/include-compare-exchange.mdx +++ b/versioned_docs/version-6.2/client-api/operations/compare-exchange/include-compare-exchange.mdx @@ -596,7 +596,7 @@ select includeCmpXchg(c) * Note: - Similar to the above dynamic query example, you can query the index with a [raw query](../../../indexes/querying/query-index.mdx#session.advanced.rawquery) using the provided RQL. + Similar to the above dynamic query example, you can query the index with a [raw query](../../../indexes/querying/query-index.mdx#sessionadvancedrawquery) using the provided RQL. diff --git a/versioned_docs/version-6.2/client-api/operations/compare-exchange/overview.mdx b/versioned_docs/version-6.2/client-api/operations/compare-exchange/overview.mdx index f8fadc6c84..f7845eac52 100644 --- a/versioned_docs/version-6.2/client-api/operations/compare-exchange/overview.mdx +++ b/versioned_docs/version-6.2/client-api/operations/compare-exchange/overview.mdx @@ -79,7 +79,7 @@ Compare exchange items are created and managed with any of the following approac * **Atomic Guards** When creating documents using a cluster-wide session RavenDB automatically creates [Atomic Guards](../../../client-api/session/cluster-transaction/atomic-guards.mdx), which are compare-exchange items that guarantee ACID transactions. - See [Cluster-wide vs. Single-node](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) for a session comparision overview. + See [Cluster-wide vs. Single-node](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) for a session comparision overview. * **Studio** Compare-exchange items can be created from the [Studio](../../../studio/database/documents/compare-exchange-view.mdx#the-compare-exchange-view) as well. @@ -622,7 +622,7 @@ Compare exchange items are created and managed with any of the following approac * **Atomic Guards** When creating documents using a cluster-wide session RavenDB automatically creates [Atomic Guards](../../../client-api/session/cluster-transaction/atomic-guards.mdx), which are compare-exchange items that guarantee ACID transactions. - See [Cluster-wide vs. Single-node](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) for a session comparision overview. + See [Cluster-wide vs. Single-node](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) for a session comparision overview. * **Studio** Compare-exchange items can be created from the [Studio](../../../studio/database/documents/compare-exchange-view.mdx#the-compare-exchange-view) as well. @@ -894,7 +894,7 @@ Compare exchange items are created and managed with any of the following approac * **Atomic Guards** When creating documents using a cluster-wide session RavenDB automatically creates [Atomic Guards](../../../client-api/session/cluster-transaction/atomic-guards.mdx), which are compare-exchange items that guarantee ACID transactions. - See [Cluster-wide vs. Single-node](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) for a session comparision overview. + See [Cluster-wide vs. Single-node](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) for a session comparision overview. * **Studio** Compare-exchange items can be created from the [Studio](../../../studio/database/documents/compare-exchange-view.mdx#the-compare-exchange-view) as well. diff --git a/versioned_docs/version-6.2/client-api/operations/how-to/switch-operations-to-a-different-database.mdx b/versioned_docs/version-6.2/client-api/operations/how-to/switch-operations-to-a-different-database.mdx index 8c04189169..62443644d7 100644 --- a/versioned_docs/version-6.2/client-api/operations/how-to/switch-operations-to-a-different-database.mdx +++ b/versioned_docs/version-6.2/client-api/operations/how-to/switch-operations-to-a-different-database.mdx @@ -27,8 +27,8 @@ export const supportedLanguages = ["csharp", "java", "python", "php", "nodejs"]; If the requested database doesn't exist on the server, an exception will be thrown. * In this page: - * [Common operation: `Operations.ForDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#common-operation:-operations.fordatabase) - * [Maintenance operation: `Maintenance.ForDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#maintenance-operation:-maintenance.fordatabase) + * [Common operation: `Operations.ForDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#common-operation:-operationsfordatabase) + * [Maintenance operation: `Maintenance.ForDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#maintenance-operation:-maintenancefordatabase) ## Common operation: `Operations.ForDatabase` @@ -205,8 +205,8 @@ As with `operations`, by default the `maintenance` operations available directly If the requested database doesn't exist on the server, an exception will be thrown. * In this page: - * [Common operation: `operations.for_database`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#common-operation:-operations.for_database) - * [Maintenance operation: `maintenance.for_database`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#maintenance-operation:-maintenance.for_database) + * [Common operation: `operations.for_database`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#common-operation:-operationsfor_database) + * [Maintenance operation: `maintenance.for_database`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#maintenance-operation:-maintenancefor_database) ## Common operation: `operations.for_database` @@ -301,7 +301,7 @@ with DocumentStore() as document_store: * In this page: * [Common operation: `forDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#common-operation:-fordatabase) - * [Maintenance operation: `maintenance.for_database`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#maintenance-operation:-maintenance.for_database) + * [Maintenance operation: `maintenance.for_database`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#maintenance-operation:-maintenancefor_database) ## Common operation: `forDatabase` @@ -411,8 +411,8 @@ try \{ If the requested database doesn't exist on the server, an exception will be thrown. * In this page: - * [Common operation: `operations.forDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#common-operation:-operations.fordatabase) - * [Maintenance operation: `maintenance.forDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#maintenance-operation:-maintenance.fordatabase) + * [Common operation: `operations.forDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#common-operation:-operationsfordatabase) + * [Maintenance operation: `maintenance.forDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#maintenance-operation:-maintenancefordatabase) ## Common operation: `operations.forDatabase` 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 f6c7ab02b1..bfb7112f22 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 @@ -208,7 +208,7 @@ IncrementalBackupFrequency = "*/20 * * * *", * RavenDB will store data in a local folder first, and transfer it to the remote destination from the local one. * If a local folder hasn't been specified, RavenDB will use the - temp folder defined in its [Storage.TempPath](../../../../server/configuration/storage-configuration.mdx#storage.temppath) setting. + temp folder defined in its [Storage.TempPath](../../../../server/configuration/storage-configuration.mdx#storagetemppath) setting. If _Storage.TempPath_ is not defined, the temporary files will be created at the same location as the data file. In either case, the folder will be used as temporary storage diff --git a/versioned_docs/version-6.2/client-api/operations/patching/single-document.mdx b/versioned_docs/version-6.2/client-api/operations/patching/single-document.mdx index 8151f447f7..5736133e3b 100644 --- a/versioned_docs/version-6.2/client-api/operations/patching/single-document.mdx +++ b/versioned_docs/version-6.2/client-api/operations/patching/single-document.mdx @@ -1164,7 +1164,7 @@ The method can be called by document ID or by document reference. * When using a JavaScript script with the _defer_ or _operations_ syntax, you can apply logic using **inline string compilation**. -* To enable this, set the [Patching.AllowStringCompilation](../../../server/configuration/patching-configuration.mdx#patching.allowstringcompilation) configuration key to _true_. +* To enable this, set the [Patching.AllowStringCompilation](../../../server/configuration/patching-configuration.mdx#patchingallowstringcompilation) configuration key to _true_. @@ -3292,7 +3292,7 @@ await documentStore.operations.send(patchOp); #### Patching using inline string compilation * When using a JavaScript script with the _defer_ or _operations_ syntax, you can apply logic using **inline string compilation**. -* To enable this, set the [Patching.AllowStringCompilation](../../../server/configuration/patching-configuration.mdx#patching.allowstringcompilation) configuration key to _true_. +* To enable this, set the [Patching.AllowStringCompilation](../../../server/configuration/patching-configuration.mdx#patchingallowstringcompilation) configuration key to _true_. diff --git a/versioned_docs/version-6.2/client-api/session/cluster-transaction/atomic-guards.mdx b/versioned_docs/version-6.2/client-api/session/cluster-transaction/atomic-guards.mdx index a7114527d0..c98e0d24ab 100644 --- a/versioned_docs/version-6.2/client-api/session/cluster-transaction/atomic-guards.mdx +++ b/versioned_docs/version-6.2/client-api/session/cluster-transaction/atomic-guards.mdx @@ -269,7 +269,7 @@ Atomic guards are removed **automatically** in the following scenarios: even if the document is expected to be new. * This is especially important if a document (originally created in a cluster-wide transaction) was deleted **outside** of a cluster-wide session - - as when using a [single-node session](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) + as when using a [single-node session](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) or the [DeleteByQueryOperation](../../../client-api/operations/common/delete-by-query.mdx). In these cases, the document is deleted, but the atomic guard remains (it is not automatically removed). If you attempt to re-create such a document without loading it first, @@ -563,7 +563,7 @@ Atomic guards are removed **automatically** in the following scenarios: even if the document is expected to be a new document. * This is especially important if a document (originally created in a cluster-wide transaction) was deleted **outside** of a cluster-wide session - - e.g., when using a [single-node session](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) + e.g., when using a [single-node session](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) or the [DeleteByQueryOperation](../../../client-api/operations/common/delete-by-query.mdx). In these cases, the document is deleted, but the atomic guard remains (it is not automatically removed). If you attempt to re-create such a document without loading it first, @@ -833,7 +833,7 @@ Atomic guards are removed **automatically** in the following scenarios: even if the document is expected to be a new document. * This is especially important if a document (originally created in a cluster-wide transaction) was deleted **outside** of a cluster-wide session - - e.g., when using a [single-node session](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) + e.g., when using a [single-node session](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) or the [DeleteByQueryOperation](../../../client-api/operations/common/delete-by-query.mdx). In these cases, the document is deleted, but the atomic guard remains (it is not automatically removed). If you attempt to re-create such a document without loading it first, @@ -1094,7 +1094,7 @@ Atomic guards are removed **automatically** in the following scenarios: even if the document is expected to be a new document. * This is especially important if a document (originally created in a cluster-wide transaction) was deleted **outside** of a cluster-wide session - - e.g., when using a [single-node session](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) + e.g., when using a [single-node session](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) or the [DeleteByQueryOperation](../../../client-api/operations/common/delete-by-query.mdx). In these cases, the document is deleted, but the atomic guard remains (it is not automatically removed). If you attempt to re-create such a document without loading it first, diff --git a/versioned_docs/version-6.2/client-api/session/cluster-transaction/overview.mdx b/versioned_docs/version-6.2/client-api/session/cluster-transaction/overview.mdx index 58e6bfbfa2..6b0863a4ef 100644 --- a/versioned_docs/version-6.2/client-api/session/cluster-transaction/overview.mdx +++ b/versioned_docs/version-6.2/client-api/session/cluster-transaction/overview.mdx @@ -30,7 +30,7 @@ export const supportedLanguages = ["csharp", "python", "php", "nodejs"]; * 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) + * [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 @@ -145,7 +145,7 @@ For a detailed description of transactions in RavenDB please refer to the [Trans * 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) + * [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 @@ -242,7 +242,7 @@ For a detailed description of transactions in RavenDB please refer to the [Trans * 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) + * [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 @@ -347,7 +347,7 @@ For a detailed description of transactions in RavenDB please refer to the [Trans * 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) + * [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 diff --git a/versioned_docs/version-6.2/client-api/session/opening-a-session.mdx b/versioned_docs/version-6.2/client-api/session/opening-a-session.mdx index 01fd1613e5..0e2dda3ffa 100644 --- a/versioned_docs/version-6.2/client-api/session/opening-a-session.mdx +++ b/versioned_docs/version-6.2/client-api/session/opening-a-session.mdx @@ -92,7 +92,7 @@ IAsyncDocumentSession OpenAsyncSession(SessionOptions options); | **NoTracking** | `bool` | `true` - The Session tracks changes made to all entities it loaded, stored, or queried for.
`false` - Tracking will be turned off.
Learn more in [Disable tracking](../../client-api/session/configuration/how-to-disable-tracking.mdx) | `false` | | **NoCaching** | `bool` | `true` - Server responses will Not be cached.
`false` - The Session caches the server responses.
Learn more in [Disable caching](../../client-api/session/configuration/how-to-disable-caching.mdx) | `false` | | **RequestExecutor** | `RequestExecutor` | ( _Advanced option_ )
The request executor the Session should use. | `null` - the default request executor is used | -| **TransactionMode** | `TransactionMode` | Specify the Session's transaction mode
`SingleNode` / `ClusterWide`
Learn more in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) | `SingleNode` | +| **TransactionMode** | `TransactionMode` | Specify the Session's transaction mode
`SingleNode` / `ClusterWide`
Learn more in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) | `SingleNode` | * Experts Only: @@ -341,7 +341,7 @@ def open_session( | **no_tracking** | `bool` | `True` - The Session tracks changes made to all entities it loaded, stored, or queried for.
`False` - Tracking will be turned off.
Learn more in [Disable tracking](../../client-api/session/configuration/how-to-disable-tracking.mdx) | `False` | | **no_caching** | `bool` | `True` - Server responses will not be cached.
`False` - The Session caches the server responses.
Learn more in [Disable caching](../../client-api/session/configuration/how-to-disable-caching.mdx) | `False` | | **request_executor** | `RequestExecutor` | ( _Advanced option_ )
The request executor the Session should use. | `None` - the default request executor is used | -| **transaction_mode** | `TransactionMode` | Specify the Session's transaction mode
`SINGLE_NODE` / `CLUSTER_WIDE`
Learn more in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) | `SINGLE_NODE` | +| **transaction_mode** | `TransactionMode` | Specify the Session's transaction mode
`SINGLE_NODE` / `CLUSTER_WIDE`
Learn more in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) | `SINGLE_NODE` | * Experts Only: @@ -432,7 +432,7 @@ public function openSession(SessionOptions $sessionOptions): DocumentSessionInte | **NoTracking** | `bool` | `true` - The Session tracks changes made to all entities it loaded, stored, or queried for.
`false` - Tracking will be turned off.
Learn more in [Disable tracking](../../client-api/session/configuration/how-to-disable-tracking.mdx) | `false` | | **NoCaching** | `bool` | `true` - Server responses will Not be cached.
`false` - The Session caches the server responses.
Learn more in [Disable caching](../../client-api/session/configuration/how-to-disable-caching.mdx) | `false` | | **RequestExecutor** | `RequestExecutor` | ( _Advanced option_ )
The request executor the Session should use. | `null` - the default request executor is used | -| **TransactionMode** | `TransactionMode` | Specify the Session's transaction mode
`SingleNode` / `ClusterWide`
Learn more in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) | `SingleNode` | +| **TransactionMode** | `TransactionMode` | Specify the Session's transaction mode
`SingleNode` / `ClusterWide`
Learn more in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) | `SingleNode` | * Experts Only: @@ -573,7 +573,7 @@ openSession(sessionOptions); | **noTracking** | boolean | `true` - The session tracks changes made to all entities it loaded, stored, or queried for.
`false` - Tracking will be turned off.
Learn more in [Disable tracking](../../client-api/session/configuration/how-to-disable-tracking.mdx) | `false` | | **noCaching** | boolean | `true` - Server responses will Not be cached.
`false` - The session caches the server responses.
Learn more in [Disable caching](../../client-api/session/configuration/how-to-disable-caching.mdx) | `false` | | **requestExecutor** | `RequestExecutor` | ( _Advanced option_ )
The request executor the session should use. | `null` - the default request executor is used | -| **transactionMode** | `TransactionMode` | Specify the session's transaction mode
`SingleNode` / `ClusterWide`
Learn more in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) | `SingleNode` | +| **transactionMode** | `TransactionMode` | Specify the session's transaction mode
`SingleNode` / `ClusterWide`
Learn more in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) | `SingleNode` | * Experts Only: diff --git a/versioned_docs/version-6.2/client-api/session/querying/document-query/what-is-document-query.mdx b/versioned_docs/version-6.2/client-api/session/querying/document-query/what-is-document-query.mdx index ff61427c33..cb62f130fb 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/document-query/what-is-document-query.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/document-query/what-is-document-query.mdx @@ -159,7 +159,7 @@ List products = await asyncSession.Advanced #### Query an index -Please refer to [Querying an index](../../../../indexes/querying/query-index.mdx#session.advanced.documentquery) for examples of querying an index using a DocumentQuery. +Please refer to [Querying an index](../../../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) for examples of querying an index using a DocumentQuery. @@ -674,7 +674,7 @@ products = list(session.advanced.document_query(object_type=Product).skip(5).tak #### Query an index -Please refer to [Querying an index](../../../../indexes/querying/query-index.mdx#session.advanced.documentquery) for examples of querying an index using document_query. +Please refer to [Querying an index](../../../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) for examples of querying an index using document_query. @@ -880,7 +880,7 @@ $employees = $session -Please refer to [Querying an index](../../../../indexes/querying/query-index.mdx#session.advanced.documentquery) for examples of querying an index using a documentQuery. +Please refer to [Querying an index](../../../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) for examples of querying an index using a documentQuery. diff --git a/versioned_docs/version-6.2/client-api/session/querying/how-to-make-a-spatial-query.mdx b/versioned_docs/version-6.2/client-api/session/querying/how-to-make-a-spatial-query.mdx index 6467cf586e..fe91b698f8 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/how-to-make-a-spatial-query.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/how-to-make-a-spatial-query.mdx @@ -691,7 +691,7 @@ order by spatial.distance( This metadata property is always available in the results. * When using **Corax**: In order to enhance performance, this property is not included in the results by default. - To get this metadata property you must set the [Indexing.Corax.IncludeSpatialDistance](../../../server/configuration/indexing-configuration.mdx#indexing.corax.includespatialdistance) configuration value to _true_. + To get this metadata property you must set the [Indexing.Corax.IncludeSpatialDistance](../../../server/configuration/indexing-configuration.mdx#indexingcoraxincludespatialdistance) configuration value to _true_. Learn about the available methods for setting an indexing configuration key in this [indexing-configuration](../../../server/configuration/indexing-configuration.mdx) article. @@ -1609,7 +1609,7 @@ order by spatial.distance( This metadata property is always available in the results. * When using **Corax**: In order to enhance performance, this property is not included in the results by default. - To get this metadata property you must set the [Indexing.Corax.IncludeSpatialDistance](../../../server/configuration/indexing-configuration.mdx#indexing.corax.includespatialdistance) configuration value to _true_. + To get this metadata property you must set the [Indexing.Corax.IncludeSpatialDistance](../../../server/configuration/indexing-configuration.mdx#indexingcoraxincludespatialdistance) configuration value to _true_. Learn about the available methods for setting an indexing configuration key in this [indexing-configuration](../../../server/configuration/indexing-configuration.mdx) article. @@ -2152,7 +2152,7 @@ order by spatial.distance( * When using __Corax__: In order to enhance performance, this property is not included in the results by default. - To get this metadata property you must set the [Indexing.Corax.IncludeSpatialDistance](../../../server/configuration/indexing-configuration.mdx#indexing.corax.includespatialdistance) configuration value to _true_. + To get this metadata property you must set the [Indexing.Corax.IncludeSpatialDistance](../../../server/configuration/indexing-configuration.mdx#indexingcoraxincludespatialdistance) configuration value to _true_. Learn about the available methods for setting an indexing configuration key in this [indexing-configuration](../../../server/configuration/indexing-configuration.mdx) article. diff --git a/versioned_docs/version-6.2/client-api/session/querying/how-to-project-query-results.mdx b/versioned_docs/version-6.2/client-api/session/querying/how-to-project-query-results.mdx index ddf95312e8..be0353d123 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/how-to-project-query-results.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/how-to-project-query-results.mdx @@ -92,8 +92,8 @@ export const supportedLanguages = ["csharp", "java", "python", "php", "nodejs"]; * But while calculations within a projection are allowed, having a very complex logic can impact query performance. So RavenDB limits the total time it will spend processing a query and its projections. Exceeding this time limit will fail the query. This is configurable, see the following configuration keys: - * [Databases.QueryTimeoutInSec](../../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec) - * [Databases.QueryOperationTimeoutInSec](../../../server/configuration/database-configuration.mdx#databases.queryoperationtimeoutinsec) + * [Databases.QueryTimeoutInSec](../../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec) + * [Databases.QueryOperationTimeoutInSec](../../../server/configuration/database-configuration.mdx#databasesqueryoperationtimeoutinsec) @@ -1240,8 +1240,8 @@ If the projected fields are stored inside the index itself (`FieldStorage.YES` i * But while calculations within a projection are allowed, having a very complex logic can impact query performance. So RavenDB limits the total time it will spend processing a query and its projections. Exceeding this time limit will fail the query. This is configurable, see the following configuration keys: - * [Databases.QueryTimeoutInSec](../../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec) - * [Databases.QueryOperationTimeoutInSec](../../../server/configuration/database-configuration.mdx#databases.queryoperationtimeoutinsec) + * [Databases.QueryTimeoutInSec](../../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec) + * [Databases.QueryOperationTimeoutInSec](../../../server/configuration/database-configuration.mdx#databasesqueryoperationtimeoutinsec) @@ -1652,8 +1652,8 @@ except Exception as e: * But while calculations within a projection are allowed, having a very complex logic can impact query performance. So RavenDB limits the total time it will spend processing a query and its projections. Exceeding this time limit will fail the query. This is configurable, see the following configuration keys: - * [Databases.QueryTimeoutInSec](../../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec) - * [Databases.QueryOperationTimeoutInSec](../../../server/configuration/database-configuration.mdx#databases.queryoperationtimeoutinsec) + * [Databases.QueryTimeoutInSec](../../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec) + * [Databases.QueryOperationTimeoutInSec](../../../server/configuration/database-configuration.mdx#databasesqueryoperationtimeoutinsec) @@ -2001,8 +2001,8 @@ Attempting multiple projection executions in the same query will result in an ex * But while calculations within a projection are allowed, having a very complex logic can impact query performance. So RavenDB limits the total time it will spend processing a query and its projections. Exceeding this time limit will fail the query. This is configurable, see the following configuration keys: - * [Databases.QueryTimeoutInSec](../../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec) - * [Databases.QueryOperationTimeoutInSec](../../../server/configuration/database-configuration.mdx#databases.queryoperationtimeoutinsec) + * [Databases.QueryTimeoutInSec](../../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec) + * [Databases.QueryOperationTimeoutInSec](../../../server/configuration/database-configuration.mdx#databasesqueryoperationtimeoutinsec) diff --git a/versioned_docs/version-6.2/client-api/session/querying/how-to-query.mdx b/versioned_docs/version-6.2/client-api/session/querying/how-to-query.mdx index 247fafa36e..63a73fd9a4 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/how-to-query.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/how-to-query.mdx @@ -43,12 +43,12 @@ export const supportedLanguages = ["csharp", "python", "php", "nodejs"]; * Query results are **cached** by default. To disable query caching see [NoCaching](../../../client-api/session/querying/how-to-customize-query.mdx#nocaching). -* Queries are timed out after a configurable time period. See [query timeout](../../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec). +* 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#session.query) - * [Session.Advanced.DocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery) - * [Session.Advanced.RawQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) + * [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) @@ -123,7 +123,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#session.query). + See more examples [below](../../../client-api/session/querying/how-to-query.mdx#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). @@ -155,7 +155,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#session.query). + See more examples [below](../../../client-api/session/querying/how-to-query.mdx#sessionquery). @@ -556,7 +556,7 @@ from "Employees" where FirstName = "Robert" ## Session.Advanced.RawQuery -* Queries defined with [Query](../../../client-api/session/querying/how-to-query.mdx#session.query) or [DocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery) are translated by the RavenDB client to [RQL](../../../client-api/session/querying/what-is-rql.mdx) +* 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) when sent to the server. * The session also gives you a way to express the query directly in RQL using the `RawQuery` method. @@ -604,7 +604,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#session.query) method: +Available custom methods and extensions for the session's [Query](../../../client-api/session/querying/how-to-query.mdx#sessionquery) method: - [AggregateBy](../../../client-api/session/querying/how-to-perform-a-faceted-search.mdx) - AnyAsync @@ -710,12 +710,12 @@ IRawDocumentQuery RawQuery(string query); * Query results are **cached** by default. To disable query caching see [NoCaching](../../../client-api/session/querying/how-to-customize-query.mdx#nocaching). -* Queries are timed out after a configurable time period. See [query timeout](../../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec). +* 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#session.query) - * [session.advanced.document_query](../../../client-api/session/querying/how-to-query.mdx#session.advanced.document_query) - * [session.advanced.raw_query](../../../client-api/session/querying/how-to-query.mdx#session.advanced.raw_query) + * [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) @@ -790,7 +790,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#session.query). + See more examples [below](../../../client-api/session/querying/how-to-query.mdx#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). @@ -822,7 +822,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#session.query). + See more examples [below](../../../client-api/session/querying/how-to-query.mdx#sessionquery). @@ -1075,7 +1075,7 @@ from "Employees" where FirstName = "Robert" ## session.advanced.raw_query -* Queries defined with [query](../../../client-api/session/querying/how-to-query.mdx#session.query) or [document_query](../../../client-api/session/querying/how-to-query.mdx#session.advanced.document_query) are translated by the RavenDB client to [RQL](../../../client-api/session/querying/what-is-rql.mdx) +* 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) when sent to the server. * The session also gives you a way to express the query directly in RQL using the `raw_query` method. @@ -1105,7 +1105,7 @@ employees = list( # Execute the query ## Custom methods -Available custom methods for session's [query](../../../client-api/session/querying/how-to-query.mdx#session.query) method: +Available custom methods for session's [query](../../../client-api/session/querying/how-to-query.mdx#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) @@ -1225,12 +1225,12 @@ def raw_query(self, query: str, object_type: Optional[Type[_T]] = None) -> RawDo To disable query caching see [NoCaching](../../../client-api/session/querying/how-to-customize-query.mdx#nocaching). * Queries are timed out after a configurable time period. - See [query timeout](../../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec). + 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#session.query) - * [session.advanced.documentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery) - * [session.advanced.rawQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) + * [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) @@ -1305,7 +1305,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#session.query). + See more examples [below](../../../client-api/session/querying/how-to-query.mdx#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) @@ -1338,7 +1338,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#session.query). + See more examples [below](../../../client-api/session/querying/how-to-query.mdx#sessionquery). @@ -1535,8 +1535,8 @@ from "Employees" where FirstName = "Robert" ## session.advanced.rawQuery -* Queries defined with [query](../../../client-api/session/querying/how-to-query.mdx#session.query) - or [documentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery) +* 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) when sent to the server. @@ -1566,7 +1566,7 @@ $employees = $session ## Custom methods -Available custom methods for session's [query](../../../client-api/session/querying/how-to-query.mdx#session.query) method: +Available custom methods for session's [query](../../../client-api/session/querying/how-to-query.mdx#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) @@ -1650,11 +1650,11 @@ public function rawQuery(?string $className, string $query): RawDocumentQueryInt * Query results are **cached** by default. To disable query caching see [noCaching](../../../client-api/session/querying/how-to-customize-query.mdx#nocaching). -* Queries are timed out after a configurable time period. See [query timeout](../../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec). +* 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#session.query) - * [session.advanced.rawQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) + * [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) @@ -1729,7 +1729,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#session.query). + See more examples [below](../../../client-api/session/querying/how-to-query.mdx#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). @@ -1761,7 +1761,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#session.query). + See more examples [below](../../../client-api/session/querying/how-to-query.mdx#sessionquery). @@ -1966,7 +1966,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#session.query) 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](../../../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. * The session also gives you a way to express the query directly in RQL using the `rawQuery` method. @@ -1994,7 +1994,7 @@ const employees = await session.advanced ## query API -Available methods for the session's [query](../../../client-api/session/querying/how-to-query.mdx#session.query) method: +Available methods for the session's [query](../../../client-api/session/querying/how-to-query.mdx#sessionquery) method: - addOrder - addParameter diff --git a/versioned_docs/version-6.2/client-api/session/querying/how-to-stream-query-results.mdx b/versioned_docs/version-6.2/client-api/session/querying/how-to-stream-query-results.mdx index 174dcc7782..b34c2ec3ad 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/how-to-stream-query-results.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/how-to-stream-query-results.mdx @@ -527,7 +527,7 @@ IEnumerator> Stream(IRawDocumentQuery query, out StreamQue | Parameters | type | description | | - | - | - | -| **query** | [IQueryable](../../../client-api/session/querying/how-to-query.mdx#session.query), [IDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery) or [IRawDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) | The query for which to stream results | +| **query** | [IQueryable](../../../client-api/session/querying/how-to-query.mdx#sessionquery), [IDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery) or [IRawDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) | The query for which to stream results | | `out` **streamQueryStats** | [StreamQueryStatistics](../../../glossary/stream-query-statistics.mdx) | Information about performed query | | Return Value | | @@ -671,7 +671,7 @@ To stream results, use the `stream` method from the `advanced` session operation | Parameters | | | | ------------- | ------------- | ----- | -| **query** | [IDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery) or [IRawDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) | Query to stream results for. | +| **query** | [IDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery) or [IRawDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) | Query to stream results for. | | `Reference` **streamQueryStats** | StreamQueryStatistics | Information about performed query. | | Return Value | | diff --git a/versioned_docs/version-6.2/client-api/session/querying/sort-query-results.mdx b/versioned_docs/version-6.2/client-api/session/querying/sort-query-results.mdx index 03dedd3524..5b208e9399 100644 --- a/versioned_docs/version-6.2/client-api/session/querying/sort-query-results.mdx +++ b/versioned_docs/version-6.2/client-api/session/querying/sort-query-results.mdx @@ -226,7 +226,7 @@ The score details can be retrieved by either: * When using __Corax__: In order to enhance performance, this metadata property is Not included in the results by default. - To get this metadata property you must set the [Indexing.Corax.IncludeDocumentScore](../../../server/configuration/indexing-configuration.mdx#indexing.corax.includedocumentscore) configuration value to _true_. + To get this metadata property you must set the [Indexing.Corax.IncludeDocumentScore](../../../server/configuration/indexing-configuration.mdx#indexingcoraxincludedocumentscore) configuration value to _true_. Learn about the available methods for setting an indexing configuration key in this [indexing-configuration](../../../server/configuration/indexing-configuration.mdx) article. * The following example shows how to get the score from the metadata of the resulting entities that were loaded to the session: @@ -924,7 +924,7 @@ The score details can be retrieved by either: * When using **Corax**: In order to enhance performance, this metadata property is Not included in the results by default. - To get this metadata property you must set the [Indexing.Corax.IncludeDocumentScore](../../../server/configuration/indexing-configuration.mdx#indexing.corax.includedocumentscore) configuration value to `True` + To get this metadata property you must set the [Indexing.Corax.IncludeDocumentScore](../../../server/configuration/indexing-configuration.mdx#indexingcoraxincludedocumentscore) configuration value to `True` Learn about the available methods for setting an indexing configuration key in this [indexing-configuration](../../../server/configuration/indexing-configuration.mdx) article. @@ -1938,7 +1938,7 @@ The score details can be retrieved by either: * When using __Corax__: In order to enhance performance, this metadata property is Not included in the results by default. - To get this metadata property you must set the [Indexing.Corax.IncludeDocumentScore](../../../server/configuration/indexing-configuration.mdx#indexing.corax.includedocumentscore) configuration value to _true_. + To get this metadata property you must set the [Indexing.Corax.IncludeDocumentScore](../../../server/configuration/indexing-configuration.mdx#indexingcoraxincludedocumentscore) configuration value to _true_. Learn about the available methods for setting an indexing configuration key in this [indexing-configuration](../../../server/configuration/indexing-configuration.mdx) article. * The following example shows how to get the score from the metadata of the resulting entities that were loaded to the session: diff --git a/versioned_docs/version-6.2/client-api/session/updating-entities.mdx b/versioned_docs/version-6.2/client-api/session/updating-entities.mdx index 832848001b..0eaacff91d 100644 --- a/versioned_docs/version-6.2/client-api/session/updating-entities.mdx +++ b/versioned_docs/version-6.2/client-api/session/updating-entities.mdx @@ -23,7 +23,7 @@ export const supportedLanguages = ["csharp", "python", "php", "nodejs"]; * To modify existing documents: - * **Retrieve** documents from the database using [Load](../../client-api/session/loading-entities.mdx#load) or by a [Query](../../client-api/session/querying/how-to-query.mdx#session.query). + * **Retrieve** documents from the database using [Load](../../client-api/session/loading-entities.mdx#load) or by a [Query](../../client-api/session/querying/how-to-query.mdx#sessionquery). The entities loaded from the documents are added to the internal entities map that the Session manages. * **Edit** the properties you wish to change. @@ -146,7 +146,7 @@ export const supportedLanguages = ["csharp", "python", "php", "nodejs"]; * To modify existing documents: - * **Retrieve** documents from the database using [load](../../client-api/session/loading-entities.mdx#load) or by a [query](../../client-api/session/querying/how-to-query.mdx#session.query). + * **Retrieve** documents from the database using [load](../../client-api/session/loading-entities.mdx#load) or by a [query](../../client-api/session/querying/how-to-query.mdx#sessionquery). The entities loaded from the documents are added to the internal entities map that the Session manages. * **Edit** the properties you wish to change. @@ -224,7 +224,7 @@ export const supportedLanguages = ["csharp", "python", "php", "nodejs"]; * To modify existing documents: * **Retrieve** documents from the database using [load](../../client-api/session/loading-entities.mdx#load) - or by a [query](../../client-api/session/querying/how-to-query.mdx#session.query). + or by a [query](../../client-api/session/querying/how-to-query.mdx#sessionquery). The entities loaded from the documents are added to the internal entities map that the session manages. * **Edit** the properties you wish to change. @@ -311,7 +311,7 @@ try \{ * To modify existing documents: - * **Retrieve** documents from the database using [load](../../client-api/session/loading-entities.mdx#load) or by a [query](../../client-api/session/querying/how-to-query.mdx#session.query). + * **Retrieve** documents from the database using [load](../../client-api/session/loading-entities.mdx#load) or by a [query](../../client-api/session/querying/how-to-query.mdx#sessionquery). The entities loaded from the documents are added to the internal entities map that the Session manages. * **Edit** the properties you wish to change. diff --git a/versioned_docs/version-6.2/client-api/session/what-is-a-session-and-how-does-it-work.mdx b/versioned_docs/version-6.2/client-api/session/what-is-a-session-and-how-does-it-work.mdx index 9013217f0b..3455205580 100644 --- a/versioned_docs/version-6.2/client-api/session/what-is-a-session-and-how-does-it-work.mdx +++ b/versioned_docs/version-6.2/client-api/session/what-is-a-session-and-how-does-it-work.mdx @@ -282,7 +282,7 @@ Assert.Same(entity1, entity2); The phrase "session's transaction mode" refers to the type of transaction that will be executed on the server-side when `SaveChanges()` is called. As mentioned earlier, the session itself does not represent an ACID transaction. - * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) transactions. + * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) transactions. @@ -571,7 +571,7 @@ Assert.assertSame(entity1, entity2); The phrase "session's transaction mode" refers to the type of transaction that will be executed on the server-side when `saveChanges()` is called. As mentioned earlier, the session itself does not represent an ACID transaction. - * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) transactions. + * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) transactions. @@ -855,7 +855,7 @@ self.assertEqual(entity1, entity2) The phrase "session's transaction mode" refers to the type of transaction that will be executed on the server-side when `save_changes()` is called. As mentioned earlier, the session itself does not represent an ACID transaction. - * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) transactions. + * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) transactions. @@ -1149,7 +1149,7 @@ $this->assertSame($entity1, $entity2); The phrase "session's transaction mode" refers to the type of transaction that will be executed on the server-side when `saveChanges()` is called. As mentioned earlier, the session itself does not represent an ACID transaction. - * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) transactions. + * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) transactions. @@ -1497,7 +1497,7 @@ assert.equal(entity1, entity2); The phrase "session's transaction mode" refers to the type of transaction that will be executed on the server-side when `saveChanges()` is called. As mentioned earlier, the session itself does not represent an ACID transaction. - * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) transactions. + * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) transactions. diff --git a/versioned_docs/version-6.2/data-archival/archived-documents-and-other-features.mdx b/versioned_docs/version-6.2/data-archival/archived-documents-and-other-features.mdx index 34afd8aa99..0a2929913c 100644 --- a/versioned_docs/version-6.2/data-archival/archived-documents-and-other-features.mdx +++ b/versioned_docs/version-6.2/data-archival/archived-documents-and-other-features.mdx @@ -58,7 +58,7 @@ export const supportedLanguages = ["csharp"]; * **Configuring indexing behavior - Static indexes**: * **At the database level or server-wide**: To control whether static indexes process archived documents from the source collection, - set the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.static.archiveddataprocessingbehavior) + set the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingstaticarchiveddataprocessingbehavior) configuration key at either the database level or server-wide (default: `ExcludeArchived`). * Note that this setting applies only to static-indexes that are using _Documents_ as their data source. This global configuration does Not apply to static-indexes based on _Time Series_ or _Counters_, which default to `IncludeArchived`. @@ -69,7 +69,7 @@ export const supportedLanguages = ["csharp"]; * **Configuring indexing behavior - Auto indexes:** * **At the database level or server-wide**: To control whether auto-indexes process archived documents at the database level or server-wide, - set the [Indexing.Auto.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.auto.archiveddataprocessingbehavior) configuration key (default `ExcludeArchived`). + set the [Indexing.Auto.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingautoarchiveddataprocessingbehavior) configuration key (default `ExcludeArchived`). * **Per index**: Unlike static indexes, you cannot configure this behavior per auto-index, because dynamic queries (which trigger auto-index creation) do not provide a way to control this setting. @@ -80,7 +80,7 @@ export const supportedLanguages = ["csharp"]; ##### Configuring archived document processing for a static index - from the Client API You can configure how a static index handles archived documents when creating the index using the Client API. -This setting will **override** the global configuration defined by the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.static.archiveddataprocessingbehavior) configuration key. +This setting will **override** the global configuration defined by the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingstaticarchiveddataprocessingbehavior) configuration key. @@ -280,7 +280,7 @@ store.Maintenance.Send(new PutIndexesOperation(indexDefinition)); ##### Configuring archived document processing for a static index - from the Studio You can configure how a static index handles archived documents directly from the Studio. -This setting will **override** the global configuration defined by the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.static.archiveddataprocessingbehavior) configuration key. +This setting will **override** the global configuration defined by the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingstaticarchiveddataprocessingbehavior) configuration key. ![Configure index](./assets/configure-static-index.png) @@ -306,7 +306,7 @@ This setting will **override** the global configuration defined by the [Indexing * **Dynamic queries (auto-indexes)**: * When making a dynamic query, RavenDB creates an auto-index to serve it. - Whether that index processes archived documents depends on the value of the [Indexing.Auto.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.auto.archiveddataprocessingbehavior) configuration key at the time the query is made. + Whether that index processes archived documents depends on the value of the [Indexing.Auto.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingautoarchiveddataprocessingbehavior) configuration key at the time the query is made. * Once created, the auto-index retains that behavior. Query results will continue to reflect the configuration that was in effect when the index was first built - even if the setting is changed later. * Learn more about dynamic queries in [Query a collection - with filtering](../client-api/session/querying/how-to-query.mdx#dynamicQuery). @@ -314,7 +314,7 @@ This setting will **override** the global configuration defined by the [Indexing * **Querying static-indexes**: * When querying a static-index, the results will include, exclude, or consist solely of archived documents depending on how the static-index was configured. The index behavior is determined by: - * the value of the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.static.archiveddataprocessingbehavior) configuration key at the time the static-index was created, or - + * the value of the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingstaticarchiveddataprocessingbehavior) configuration key at the time the static-index was created, or - * the explicit setting in the index definition, which overrides the global configuration key. * The index's archived data processing behavior can be modified after its creation using the Studio or the Client API. @@ -340,7 +340,7 @@ This setting will **override** the global configuration defined by the [Indexing ##### Configuring archived document processing for a data subscription task - from the Client API You can configure how a subscription task handles archived documents when creating the subscription using the Client API. -This setting will **override** the global configuration defined by the [Subscriptions.ArchivedDataProcessingBehavior](../server/configuration/subscription-configuration.mdx#subscriptions.archiveddataprocessingbehavior) configuration key. +This setting will **override** the global configuration defined by the [Subscriptions.ArchivedDataProcessingBehavior](../server/configuration/subscription-configuration.mdx#subscriptionsarchiveddataprocessingbehavior) configuration key. @@ -384,7 +384,7 @@ Example: ##### Configuring archived document processing for a data subscription task - from the Studio You can configure how a subscription task handles archived documents directly from the Studio. -This setting will **override** the global configuration defined by the [Subscriptions.ArchivedDataProcessingBehavior](../server/configuration/subscription-configuration.mdx#subscriptions.archiveddataprocessingbehavior) configuration key. +This setting will **override** the global configuration defined by the [Subscriptions.ArchivedDataProcessingBehavior](../server/configuration/subscription-configuration.mdx#subscriptionsarchiveddataprocessingbehavior) configuration key. ![Configure subscription](./assets/configure-subscription.png) diff --git a/versioned_docs/version-6.2/data-archival/unarchiving-documents.mdx b/versioned_docs/version-6.2/data-archival/unarchiving-documents.mdx index a5e894a9ec..4dbced57b9 100644 --- a/versioned_docs/version-6.2/data-archival/unarchiving-documents.mdx +++ b/versioned_docs/version-6.2/data-archival/unarchiving-documents.mdx @@ -180,7 +180,7 @@ It will unarchive all archived documents in the _Orders_ collection. As a result, no documents will be unarchived by the patch operation. * For example, the following patch query uses a dynamic query that creates an auto-index. - If the [Indexing.Auto.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.auto.archiveddataprocessingbehavior) configuration key is set to its default `ExcludeArchived` value, + If the [Indexing.Auto.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingautoarchiveddataprocessingbehavior) configuration key is set to its default `ExcludeArchived` value, then even if archived documents exist in the _Orders_ collection with `ShipTo.Country == 'USA'`, they will not be matched - because the auto-index does not include them - and the patch operation will not unarchive any documents. @@ -208,9 +208,9 @@ Two possible workarounds are: Use this option only if including archived documents in the index aligns with your indexing strategy. **For auto-indexes**: - Set the [Indexing.Auto.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.auto.archiveddataprocessingbehavior) configuration key to `IncludeArchived`. + Set the [Indexing.Auto.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingautoarchiveddataprocessingbehavior) configuration key to `IncludeArchived`. **For static-indexes**: - Set the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.static.archiveddataprocessingbehavior) configuration key to `IncludeArchived`, + Set the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingstaticarchiveddataprocessingbehavior) configuration key to `IncludeArchived`, or - configure the definition of the specific static-index to include archived documents. See [Archived documents and indexing](../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-indexing). diff --git a/versioned_docs/version-6.2/document-extensions/counters/counters-and-other-features.mdx b/versioned_docs/version-6.2/document-extensions/counters/counters-and-other-features.mdx index 0366377069..d04c16f05e 100644 --- a/versioned_docs/version-6.2/document-extensions/counters/counters-and-other-features.mdx +++ b/versioned_docs/version-6.2/document-extensions/counters/counters-and-other-features.mdx @@ -58,7 +58,7 @@ Create queries **using code**, or send the server **raw queries** for execution. * 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. -* Use [Session.Query](../../client-api/session/querying/how-to-query.mdx#session.query) to code queries yourself. +* Use [Session.Query](../../client-api/session/querying/how-to-query.mdx#sessionquery) to code queries yourself. * **Returned Counter Value**: **Accumulated** A Counter's value is returned as a single sum, with no specification of the Counter's value on each node. @@ -83,7 +83,7 @@ Create queries **using code**, or send the server **raw queries** for execution. -* Use [RawQuery](../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) to send the server raw RQL expressions for execution. +* Use [RawQuery](../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) to send the server raw RQL expressions for execution. * You can use the `counter` method. **Returned Counter Value**: **Accumulated** @@ -750,7 +750,7 @@ Create queries **using code**, or send the server **raw queries** for execution. * 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. -* Use [session.query](../../client-api/session/querying/how-to-query.mdx#session.query) to code queries yourself. +* Use [session.query](../../client-api/session/querying/how-to-query.mdx#sessionquery) to code queries yourself. * **Returned Counter Value**: **Accumulated** A Counter's value is returned as a single sum, with no specification of the Counter's value on each node. @@ -762,7 +762,7 @@ Create queries **using code**, or send the server **raw queries** for execution. -* Use [RawQuery](../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) to send the server raw RQL expressions for execution. +* Use [RawQuery](../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) to send the server raw RQL expressions for execution. * You can use the `counter` method. **Returned Counter Value**: **Accumulated** @@ -1051,7 +1051,7 @@ Send the server **raw queries** for execution. * 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. -* Use [RawQuery](../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) to send the server raw RQL expressions for execution. +* Use [RawQuery](../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) to send the server raw RQL expressions for execution. * You can use the `counter` method. **Returned Counter Value**: **Accumulated** @@ -1283,7 +1283,7 @@ Create queries **using code**, or send the server **raw queries** for execution. * 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. -* Use [Session.Query](../../client-api/session/querying/how-to-query.mdx#session.query) to code queries yourself. +* Use [Session.Query](../../client-api/session/querying/how-to-query.mdx#sessionquery) to code queries yourself. * **Returned Counter Value**: **Accumulated** A Counter's value is returned as a single sum, with no specification of the Counter's value on each node. @@ -1300,7 +1300,7 @@ for (let counterValue in queryResults) \{ -* Use [RawQuery](../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) to send the server raw RQL expressions for execution. +* Use [RawQuery](../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) to send the server raw RQL expressions for execution. * You can use the `counter` method. **Returned Counter Value**: **Accumulated** diff --git a/versioned_docs/version-6.2/document-extensions/revisions/client-api/overview.mdx b/versioned_docs/version-6.2/document-extensions/revisions/client-api/overview.mdx index 9689589e8e..1faa78fdb3 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/client-api/overview.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/client-api/overview.mdx @@ -49,7 +49,7 @@ export const supportedLanguages = ["csharp", "java", "python", "php", "nodejs"]; * **Include revisions**: * [IncludeRevisions](../../../document-extensions/revisions/client-api/session/including.mdx#section) - include revisions when retrieving documents via `Session.Load` or `Session.Query`. - * [RawQuery](../../../document-extensions/revisions/client-api/session/including.mdx#including-revisions-with-session.advanced.rawquery) - Learn how to include revisions when retrieving documents via raw queries. + * [RawQuery](../../../document-extensions/revisions/client-api/session/including.mdx#including-revisions-with-sessionadvancedrawquery) - Learn how to include revisions when retrieving documents via raw queries. * **Count revisions**: * [GetCountFor](../../../document-extensions/revisions/client-api/session/counting.mdx#getcountfor) - get the number of revisions kept for a document. @@ -103,7 +103,7 @@ export const supportedLanguages = ["csharp", "java", "python", "php", "nodejs"]; * [Including revisions](../../../document-extensions/revisions/client-api/session/including.mdx) * [IncludeRevisions](../../../document-extensions/revisions/client-api/session/including.mdx#section) Use this method to include document revisions when retrieving documents via `Session.Load` or `Session.Query`. - * [RawQuery](../../../document-extensions/revisions/client-api/session/including.mdx#including-revisions-with-session.advanced.rawquery) + * [RawQuery](../../../document-extensions/revisions/client-api/session/including.mdx#including-revisions-with-sessionadvancedrawquery) Learn here how to include revisions with documents retrieved via raw queries. @@ -232,7 +232,7 @@ about creating a revision even if revision configuration is disabled. * **Include revisions**: * [includeRevisions](../../../document-extensions/revisions/client-api/session/including.mdx#section) - include revisions when retrieving documents via `session.load` or `session.query`. - * [rawQuery](../../../document-extensions/revisions/client-api/session/including.mdx#including-revisions-with-session.advanced.rawquery) - Learn how to include revisions when retrieving documents via raw queries. + * [rawQuery](../../../document-extensions/revisions/client-api/session/including.mdx#including-revisions-with-sessionadvancedrawquery) - Learn how to include revisions when retrieving documents via raw queries. * **Count revisions**: * [getCountFor](../../../document-extensions/revisions/client-api/session/counting.mdx#getcountfor) - get the number of revisions kept for a document. diff --git a/versioned_docs/version-6.2/document-extensions/revisions/overview.mdx b/versioned_docs/version-6.2/document-extensions/revisions/overview.mdx index abcc387b50..178694daf4 100644 --- a/versioned_docs/version-6.2/document-extensions/revisions/overview.mdx +++ b/versioned_docs/version-6.2/document-extensions/revisions/overview.mdx @@ -206,7 +206,7 @@ using the same blittable JSON document format as regular documents. ##### Revisions Compression * By default, revisions are compressed. - This setting can be customized server-wide via the [CompressRevisionsDefault](../../server/configuration/database-configuration.mdx#databases.compression.compressrevisionsdefault) configuration key. + This setting can be customized server-wide via the [CompressRevisionsDefault](../../server/configuration/database-configuration.mdx#databasescompressioncompressrevisionsdefault) configuration key. * At the database level, revisions compression can be customized via the database record, as shown in [this example](../../server/storage/documents-compression.mdx#set-compression-for-selected-collections). * Individual fields are compressed as they are compressed in regular documents: @@ -525,7 +525,7 @@ using the same blittable JSON document format as regular documents. ##### Revisions Compression * By default, revisions are compressed. - This setting can be customized server-wide via the [CompressRevisionsDefault](../../server/configuration/database-configuration.mdx#databases.compression.compressrevisionsdefault) configuration key. + This setting can be customized server-wide via the [CompressRevisionsDefault](../../server/configuration/database-configuration.mdx#databasescompressioncompressrevisionsdefault) configuration key. * At the database level, revisions compression can be customized via the database record, as shown in [this example](../../server/storage/documents-compression.mdx#set-compression-for-selected-collections). * Individual fields are compressed as they are compressed in regular documents: @@ -549,7 +549,7 @@ Read [here](../../document-extensions/revisions/revisions-and-other-features.mdx * **Revisions compression** * Revisions are compressed by default. - Learn [here](../../server/configuration/database-configuration.mdx#databases.compression.compressrevisionsdefault) + Learn [here](../../server/configuration/database-configuration.mdx#databasescompressioncompressrevisionsdefault) how to toggle this database option on and off. * Learn [here](../../server/storage/documents-compression.mdx) how to apply Document Compression to revisions. * Individual fields are compressed as they are compressed in regular documents: @@ -804,7 +804,7 @@ using the same blittable JSON document format as regular documents. ##### Revisions Compression * By default, revisions are compressed. - This setting can be customized server-wide via the [CompressRevisionsDefault](../../server/configuration/database-configuration.mdx#databases.compression.compressrevisionsdefault) configuration key. + This setting can be customized server-wide via the [CompressRevisionsDefault](../../server/configuration/database-configuration.mdx#databasescompressioncompressrevisionsdefault) configuration key. * At the database level, revisions compression can be customized via the database record, as shown in [this example](../../server/storage/documents-compression.mdx#set-compression-for-selected-collections). * Individual fields are compressed as they are compressed in regular documents: diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/with-raw-queries.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/with-raw-queries.mdx index a5671a523a..9e253dbd96 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/with-raw-queries.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/client-api/session/include/with-raw-queries.mdx @@ -22,7 +22,7 @@ export const supportedLanguages = ["csharp", "nodejs"]; * Use `include timeseries` in your RQL expression in order to include time series data when making - a raw query via [session.Advanced.RawQuery](../../../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery). + a raw query via [session.Advanced.RawQuery](../../../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery). * The included time series data is stored within the session and can be provided instantly when requested without any additional server calls. @@ -94,7 +94,7 @@ and _include_ entries from the document's "HeartRates" time series. * Use `include timeseries` in your RQL expression in order to include time series data when making - a raw query via [session.advanced.rawQuery](../../../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery). + a raw query via [session.advanced.rawQuery](../../../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery). * The included time series data is stored within the session and can be provided instantly when requested without any additional server calls. 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 b7569b7e18..877cbad54f 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 @@ -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#timeseries.increment) +* You can use the Javascript [timeseries.increment](../../../../document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx#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). @@ -34,7 +34,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * 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#timeseries.increment) + * [`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) @@ -112,7 +112,7 @@ void Increment(double value); ## Usage Sample In this sample we use -[session.Advanced.Defer](../../../../document-extensions/timeseries/client-api/session/patch.mdx#patching-using-session.advanced.defer) +[session.Advanced.Defer](../../../../document-extensions/timeseries/client-api/session/patch.mdx#patching-using-sessionadvanceddefer) to patch an incremental time series. We go through a series of collected stock prices, and add a **2** factor to each collected stock price, that has been originally miscalculated. 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 efede0c0b7..a9ed8a6c16 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 @@ -20,7 +20,7 @@ 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#incrementaltimeseriesfor.delete) + * [`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) 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 432948cff9..5ce3b581be 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 @@ -30,7 +30,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [`IncrementalTimeSeriesFor.Get`](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx#incrementaltimeseriesfor.get) + * [`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) * [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 507e3a5138..65b9b75455 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 @@ -26,7 +26,7 @@ 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#timeseriesfor.append) + * [`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) 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 e52ae48c0a..30cb6c0df0 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 @@ -123,7 +123,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Incremental: Rollup policies can be created as above. However, the resulting rollup time series is non incremental. - It can be handled via [TimeSeriesFor](../../../document-extensions/timeseries/client-api/session/append.mdx#timeseriesfor.append), not + It can be handled via [TimeSeriesFor](../../../document-extensions/timeseries/client-api/session/append.mdx#timeseriesforappend), not [IncrementalTimeSeriesFor](../../../document-extensions/timeseries/incremental-time-series/client-api/session/overview.mdx#methods), and its values can no longer be [Incremented](../../../document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx). diff --git a/versioned_docs/version-6.2/document-extensions/timeseries/querying/stream-timeseries.mdx b/versioned_docs/version-6.2/document-extensions/timeseries/querying/stream-timeseries.mdx index b0950da419..8c70274601 100644 --- a/versioned_docs/version-6.2/document-extensions/timeseries/querying/stream-timeseries.mdx +++ b/versioned_docs/version-6.2/document-extensions/timeseries/querying/stream-timeseries.mdx @@ -85,7 +85,7 @@ IEnumerator> Stream( | Parameters | Type | Description | | - | - | - | -| **query** | [IQueryable](../../../client-api/session/querying/how-to-query.mdx#session.query), [IDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery) or [IRawDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) | Query to stream results for. | +| **query** | [IQueryable](../../../client-api/session/querying/how-to-query.mdx#sessionquery), [IDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery) or [IRawDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) | Query to stream results for. | | **streamQueryStats** | `out` [StreamQueryStatistics](../../../glossary/stream-query-statistics.mdx) | Information about performed query. | | Return Value | Description | @@ -243,7 +243,7 @@ found [here](../../../client-api/session/querying/how-to-stream-query-results.md | Parameters | | | | ------------- | ------------- | ----- | -| **query** | [IDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery) or [IRawDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) | Query to stream results for. | +| **query** | [IDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery) or [IRawDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) | Query to stream results for. | | `Reference` **streamQueryStats** | StreamQueryStatistics | Information about performed query. | | Return Value | | diff --git a/versioned_docs/version-6.2/indexes/boosting.mdx b/versioned_docs/version-6.2/indexes/boosting.mdx index e48c76efcc..bed948bf36 100644 --- a/versioned_docs/version-6.2/indexes/boosting.mdx +++ b/versioned_docs/version-6.2/indexes/boosting.mdx @@ -287,7 +287,7 @@ where ShipToCountry == "poland" or CompanyCountry == "portugal" * By default, whenever boosting is applied, either via dynamic querying or when querying an index that has a boosting factor in its definition, the results will be automatically ordered by the score. -* This behavior can be modified using the [OrderByScoreAutomaticallyWhenBoostingIsInvolved](../server/configuration/indexing-configuration.mdx#indexing.orderbyscoreautomaticallywhenboostingisinvolved) +* This behavior can be modified using the [OrderByScoreAutomaticallyWhenBoostingIsInvolved](../server/configuration/indexing-configuration.mdx#indexingorderbyscoreautomaticallywhenboostingisinvolved) configuration key. * Refer to the [Get resulting score](../client-api/session/querying/sort-query-results.mdx#get-resulting-score) @@ -388,7 +388,7 @@ Boosting is also available at the query level. * By default, whenever boosting is involved, either via a dynamic query or when querying an index that has a boosting factor in its definition, the results will be automatically ordered by the score. -* This behavior can be modified using the [OrderByScoreAutomaticallyWhenBoostingIsInvolved](../server/configuration/indexing-configuration.mdx#indexing.orderbyscoreautomaticallywhenboostingisinvolved) +* This behavior can be modified using the [OrderByScoreAutomaticallyWhenBoostingIsInvolved](../server/configuration/indexing-configuration.mdx#indexingorderbyscoreautomaticallywhenboostingisinvolved) configuration key. @@ -686,7 +686,7 @@ where ShipToCountry == "poland" or CompanyCountry == "portugal" * By default, whenever boosting is applied, either via dynamic querying or when querying an index that has a boosting factor in its definition, the results will be automatically ordered by the score. -* This behavior can be modified using the [OrderByScoreAutomaticallyWhenBoostingIsInvolved](../server/configuration/indexing-configuration.mdx#indexing.orderbyscoreautomaticallywhenboostingisinvolved) +* This behavior can be modified using the [OrderByScoreAutomaticallyWhenBoostingIsInvolved](../server/configuration/indexing-configuration.mdx#indexingorderbyscoreautomaticallywhenboostingisinvolved) configuration key. * Refer to the [Get resulting score](../client-api/session/querying/sort-query-results.mdx#get-resulting-score) @@ -859,7 +859,7 @@ where ShipToCountry == "poland" or CompanyCountry == "portugal" * By default, whenever boosting is applied, either via dynamic querying or when querying an index that has a boosting factor in its definition, the results will be automatically ordered by the score. -* This behavior can be modified using the [OrderByScoreAutomaticallyWhenBoostingIsInvolved](../server/configuration/indexing-configuration.mdx#indexing.orderbyscoreautomaticallywhenboostingisinvolved) +* This behavior can be modified using the [OrderByScoreAutomaticallyWhenBoostingIsInvolved](../server/configuration/indexing-configuration.mdx#indexingorderbyscoreautomaticallywhenboostingisinvolved) configuration key. * Refer to the [Get resulting score](../client-api/session/querying/sort-query-results.mdx#get-resulting-score) diff --git a/versioned_docs/version-6.2/indexes/creating-and-deploying.mdx b/versioned_docs/version-6.2/indexes/creating-and-deploying.mdx index b48e332930..c4968e7d39 100644 --- a/versioned_docs/version-6.2/indexes/creating-and-deploying.mdx +++ b/versioned_docs/version-6.2/indexes/creating-and-deploying.mdx @@ -487,12 +487,12 @@ where FirstName = "Robert" and LastName = "King" * This is done in order to avoid marking indexes as idle for databases that were offline for a long period of time, as well as for databases that were just restored from a snapshot or a backup. * To set the time before marking an index as idle, use the - [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key. + [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key. Setting this value too high is not recommended, as it may lead to performance degradation by causing unnecessary and redundant work for the indexes. * An `idle` auto-index will resume its work and return to `normal` state upon its next query, or when resetting the index. * If not resumed, the idle auto-index will be deleted by the server after the time period defined in the - [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key + [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key (72 hours by default). @@ -507,7 +507,7 @@ where FirstName = "Robert" and LastName = "King" **How to disable**: -* You can disable auto-indexes by setting the [Indexing.DisableQueryOptimizerGeneratedIndexes](../server/configuration/indexing-configuration.mdx#indexing.disablequeryoptimizergeneratedindexes) configuration key. +* You can disable auto-indexes by setting the [Indexing.DisableQueryOptimizerGeneratedIndexes](../server/configuration/indexing-configuration.mdx#indexingdisablequeryoptimizergeneratedindexes) configuration key. This will affect all queries made both from the **Client API** and the **Studio**. * Alternatively, you can disable auto-indexes from the Studio. @@ -1187,12 +1187,12 @@ where FirstName = "Robert" and LastName = "King" * This is done in order to avoid marking indexes as idle for databases that were offline for a long period of time, as well as for databases that were just restored from a snapshot or a backup. * To set the time before marking an index as idle, use the - [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key. + [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key. Setting this value too high is not recommended, as it may lead to performance degradation by causing unnecessary and redundant work for the indexes. * An `idle` auto-index will resume its work and return to `normal` state upon its next query, or when resetting the index. * If not resumed, the idle auto-index will be deleted by the server after the time period defined in the - [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key + [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key (72 hours by default). @@ -1207,7 +1207,7 @@ where FirstName = "Robert" and LastName = "King" **How to disable**: -* You can disable auto-indexes by setting the [Indexing.DisableQueryOptimizerGeneratedIndexes](../server/configuration/indexing-configuration.mdx#indexing.disablequeryoptimizergeneratedindexes) configuration key. +* You can disable auto-indexes by setting the [Indexing.DisableQueryOptimizerGeneratedIndexes](../server/configuration/indexing-configuration.mdx#indexingdisablequeryoptimizergeneratedindexes) configuration key. This will affect all queries made both from the **Client API** and the **Studio**. * Alternatively, you can disable auto-indexes from the Studio. diff --git a/versioned_docs/version-6.2/indexes/index-administration.mdx b/versioned_docs/version-6.2/indexes/index-administration.mdx index 8e066eb404..9b4979930d 100644 --- a/versioned_docs/version-6.2/indexes/index-administration.mdx +++ b/versioned_docs/version-6.2/indexes/index-administration.mdx @@ -150,7 +150,7 @@ An index can be in one of the following states: * Specifically, an **auto-index** is marked as _'Idle'_ when the time difference between its last-query-time and the most recent time the database was queried (using any other index) exceeds a configurable threshold. This threshold is set by the - [Indexing.TimeToWaitBeforeMarkingAutoIndexAsIdleInMin](../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforemarkingautoindexasidleinmin) configuration key (30 minutes by default). + [Indexing.TimeToWaitBeforeMarkingAutoIndexAsIdleInMin](../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforemarkingautoindexasidleinmin) configuration key (30 minutes by default). * This mechanism is designed to prevent auto-indexes from being marked as idle in databases that were offline for a long period, had no new data to index, were not queried, or were recently restored from a snapshot or backup. @@ -164,11 +164,11 @@ An index can be in one of the following states: * When [the database is reloaded](../studio/database/settings/database-settings.mdx#how-to-reload-the-database). * If the idle auto-index is Not returned to the _'Normal'_ state, the server will **delete** it after a configurable time period, - set by the [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key (72 hours by default). + set by the [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key (72 hours by default). * Note: The server evaluates whether an auto-index should be marked as idle, or whether an idle auto-index should be deleted, - at intervals defined by the [Indexing.CleanupIntervalInMin](../server/configuration/indexing-configuration.mdx#indexing.cleanupintervalinmin) configuration key (10 minutes by default). + at intervals defined by the [Indexing.CleanupIntervalInMin](../server/configuration/indexing-configuration.mdx#indexingcleanupintervalinmin) configuration key (10 minutes by default). If _TimeToWaitBeforeMarkingAutoIndexAsIdleInMin_ or _TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs_ are set to values smaller than the cleanup interval, the index will be marked as idle or deleted only after the cleanup interval elapses. @@ -201,8 +201,8 @@ An index can be in one of the following states: **Expert configuration options**: -* [Server.IndexingAffinityMask](../server/configuration/server-configuration.mdx#server.indexingaffinitymask) - Control the affinity mask of indexing threads -* [Server.NumberOfUnusedCoresByIndexes](../server/configuration/server-configuration.mdx#server.numberofunusedcoresbyindexes) - Set the number of cores that _won't_ be used by indexes +* [Server.IndexingAffinityMask](../server/configuration/server-configuration.mdx#serverindexingaffinitymask) - Control the affinity mask of indexing threads +* [Server.NumberOfUnusedCoresByIndexes](../server/configuration/server-configuration.mdx#servernumberofunusedcoresbyindexes) - Set the number of cores that _won't_ be used by indexes diff --git a/versioned_docs/version-6.2/indexes/index-throttling.mdx b/versioned_docs/version-6.2/indexes/index-throttling.mdx index dd14345adf..bfd24f3fa0 100644 --- a/versioned_docs/version-6.2/indexes/index-throttling.mdx +++ b/versioned_docs/version-6.2/indexes/index-throttling.mdx @@ -57,7 +57,7 @@ They are therefore expected to remain stale longer than indexes that are process ## Throttling and Batches -The delay in index procession increases the size of Item [batches](../server/configuration/indexing-configuration.mdx#indexing.mapbatchsize) +The delay in index procession increases the size of Item [batches](../server/configuration/indexing-configuration.mdx#indexingmapbatchsize) that are processed during indexing intervals. In special cases, throttled indexes' batches are processed without delay. @@ -72,7 +72,7 @@ In special cases, throttled indexes' batches are processed without delay. ## Setting Index Throttling ### Server-Wide Index Throttling - Index Throttling can be set server-wide using a designated [configuration option](../server/configuration/configuration-options.mdx#settings.json). + Index Throttling can be set server-wide using a designated [configuration option](../server/configuration/configuration-options.mdx#settingsjson). Setting the server-wide configuration option will apply to all databases on a given node. * Set the index throttling time interval in Milliseconds using the `Indexing.Throttling.TimeIntervalInMs` configuration option, e.g.: @@ -129,7 +129,7 @@ and [database](../indexes/index-throttling.mdx#index-throttling-per-database) se The batch size can be left for RavenDB to decide, or you can set it yourself using - the [Indexing.MapBatchSize](../server/configuration/indexing-configuration.mdx#indexing.mapbatchsize) property. + the [Indexing.MapBatchSize](../server/configuration/indexing-configuration.mdx#indexingmapbatchsize) property. {`Configuration = new IndexConfiguration diff --git a/versioned_docs/version-6.2/indexes/indexing-basics.mdx b/versioned_docs/version-6.2/indexes/indexing-basics.mdx index 625990b41d..c5f641bf78 100644 --- a/versioned_docs/version-6.2/indexes/indexing-basics.mdx +++ b/versioned_docs/version-6.2/indexes/indexing-basics.mdx @@ -34,7 +34,7 @@ You can read more about stale indexes [here](../indexes/stale-indexes.mdx). ## Querying -RavenDB uses `Raven Query Language (RQL)`, an SQL-like querying language for querying. The easiest way for us would be to expose a method in which you could pass your RQL-flavored query as a string (we [did](../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) that) and do not bother about anything else. +RavenDB uses `Raven Query Language (RQL)`, an SQL-like querying language for querying. The easiest way for us would be to expose a method in which you could pass your RQL-flavored query as a string (we [did](../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) that) and do not bother about anything else. The fact is that we did not stop at this point. We went much further by exposing LINQ-based querying with strong-type support that hides all Lucene syntax complexity: @@ -66,7 +66,7 @@ where FirstName = 'Robert' -You can also create queries manually by using [DocumentQuery](../client-api/session/querying/document-query/what-is-document-query.mdx) or [RawQuery](../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery), both available as a part of advanced session operations: +You can also create queries manually by using [DocumentQuery](../client-api/session/querying/document-query/what-is-document-query.mdx) or [RawQuery](../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery), both available as a part of advanced session operations: @@ -132,7 +132,7 @@ You can read more about stale indexes [here](../indexes/stale-indexes.mdx). ## Querying -RavenDB uses `Raven Query Language (RQL)`, an SQL-like querying language for querying. The easiest way for us would be to expose a method in which you could pass your RQL-flavored query as a string (we [did](../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) that) and do not bother about anything else. +RavenDB uses `Raven Query Language (RQL)`, an SQL-like querying language for querying. The easiest way for us would be to expose a method in which you could pass your RQL-flavored query as a string (we [did](../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) that) and do not bother about anything else. The fact is that we did not stop at this point. We went much further, by exposing querying methods that hides all Lucene syntax complexity: @@ -154,7 +154,7 @@ where FirstName = 'Robert' -You can also create queries by using [RawQuery](../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery). It is available as a part of advanced session operations: +You can also create queries by using [RawQuery](../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery). It is available as a part of advanced session operations: @@ -209,7 +209,7 @@ You can read more about stale indexes [here](../indexes/stale-indexes.mdx). ## Querying -RavenDB uses `Raven Query Language (RQL)`, an SQL-like querying language for querying. The easiest way for us would be to expose a method in which you could pass your RQL-flavored query as a string (we [did](../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) that) and do not bother about anything else. +RavenDB uses `Raven Query Language (RQL)`, an SQL-like querying language for querying. The easiest way for us would be to expose a method in which you could pass your RQL-flavored query as a string (we [did](../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) that) and do not bother about anything else. The fact is that we did not stop at this point. We went much further, by exposing querying methods that hides all Lucene syntax complexity: @@ -231,7 +231,7 @@ where FirstName = 'Robert' -You can also create queries by using [RawQuery](../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery). It is available as a part of advanced session operations: +You can also create queries by using [RawQuery](../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery). It is available as a part of advanced session operations: diff --git a/versioned_docs/version-6.2/indexes/indexing-nested-data.mdx b/versioned_docs/version-6.2/indexes/indexing-nested-data.mdx index 162499432d..d3ed554d11 100644 --- a/versioned_docs/version-6.2/indexes/indexing-nested-data.mdx +++ b/versioned_docs/version-6.2/indexes/indexing-nested-data.mdx @@ -563,7 +563,7 @@ where Color == "black" RavenDB will issue a **High indexing fanout ratio** alert in the Studio notification center. * You can control when this performance hint is created by setting the - [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../server/configuration/performance-hints-configuration.mdx#performancehints.indexing.maxindexoutputsperdocument) configuration key + [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../server/configuration/performance-hints-configuration.mdx#performancehintsindexingmaxindexoutputsperdocument) configuration key (default is 1024). * So, for example, adding another OnlineShop document with a `tShirt` object containing 1025 items @@ -1135,7 +1135,7 @@ where Color == "black" RavenDB will issue a **High indexing fanout ratio** alert in the Studio notification center. * You can control when this performance hint is created by setting the - [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../server/configuration/performance-hints-configuration.mdx#performancehints.indexing.maxindexoutputsperdocument) configuration key + [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../server/configuration/performance-hints-configuration.mdx#performancehintsindexingmaxindexoutputsperdocument) configuration key (default is 1024). * So, for example, adding another OnlineShop document with a `tShirt` object containing 1025 items @@ -1757,7 +1757,7 @@ where Color == "black" RavenDB will issue a **High indexing fanout ratio** alert in the Studio notification center. * You can control when this performance hint is created by setting the - [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../server/configuration/performance-hints-configuration.mdx#performancehints.indexing.maxindexoutputsperdocument) configuration key + [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../server/configuration/performance-hints-configuration.mdx#performancehintsindexingmaxindexoutputsperdocument) configuration key (default is 1024). * So, for example, adding another OnlineShop document with a `tShirt` object containing 1025 items @@ -2154,7 +2154,7 @@ where color == "black" RavenDB will issue a **High indexing fanout ratio** alert in the Studio notification center. * You can control when this performance hint is created by setting the - [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../server/configuration/performance-hints-configuration.mdx#performancehints.indexing.maxindexoutputsperdocument) configuration key + [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../server/configuration/performance-hints-configuration.mdx#performancehintsindexingmaxindexoutputsperdocument) configuration key (default is 1024). * So, for example, adding another OnlineShop document with a `tShirt` object containing 1025 items diff --git a/versioned_docs/version-6.2/indexes/javascript-indexes.mdx b/versioned_docs/version-6.2/indexes/javascript-indexes.mdx index e92d2eef48..d16fc54618 100644 --- a/versioned_docs/version-6.2/indexes/javascript-indexes.mdx +++ b/versioned_docs/version-6.2/indexes/javascript-indexes.mdx @@ -73,7 +73,7 @@ export const supportedLanguages = ["csharp", "java"]; while **C# static indexes** require a [User/Admin](../server/security/authorization/security-clearance-and-permissions.mdx#section) certificate or higher. * To restrict the creation of JavaScript indexes to database admins (and above), - set the [Indexing.Static.RequireAdminToDeployJavaScriptIndexes](../server/configuration/indexing-configuration.mdx#indexing.static.requireadmintodeployjavascriptindexes) configuration to `true`. + set the [Indexing.Static.RequireAdminToDeployJavaScriptIndexes](../server/configuration/indexing-configuration.mdx#indexingstaticrequireadmintodeployjavascriptindexes) configuration to `true`. * All other capabilities and features of JavaScript indexes are identical to those of [C# indexes](../indexes/indexing-basics.mdx). @@ -231,7 +231,7 @@ public class BlogPostComment #### Example III - Map index - with inline string compilation * To define a JavaScript index using inline string compilation, - you must set the [Indexing.AllowStringCompilation](../server/configuration/indexing-configuration.mdx#indexing.allowstringcompilation) configuration key to _true_. + you must set the [Indexing.AllowStringCompilation](../server/configuration/indexing-configuration.mdx#indexingallowstringcompilation) configuration key to _true_. * The following indexes use inline string compilation to evaluate whether each product’s `UnitsInStock` is low. diff --git a/versioned_docs/version-6.2/indexes/map-indexes.mdx b/versioned_docs/version-6.2/indexes/map-indexes.mdx index 28bfe803e9..9ffcdb8431 100644 --- a/versioned_docs/version-6.2/indexes/map-indexes.mdx +++ b/versioned_docs/version-6.2/indexes/map-indexes.mdx @@ -855,10 +855,10 @@ Learn more [here](../indexes/indexing-related-documents.mdx). ## Indexing Missing Fields By default, indexes will not index a document that contains none of the specified fields. This behavior can be changed -using the [Indexing.IndexEmptyEntries](../server/configuration/indexing-configuration.mdx#indexing.indexemptyentries) +using the [Indexing.IndexEmptyEntries](../server/configuration/indexing-configuration.mdx#indexingindexemptyentries) configuration option. -The option [Indexing.IndexMissingFieldsAsNull](../server/configuration/indexing-configuration.mdx#indexing.indexmissingfieldsasnull) +The option [Indexing.IndexMissingFieldsAsNull](../server/configuration/indexing-configuration.mdx#indexingindexmissingfieldsasnull) determines whether missing fields in documents are indexed with the value `null`, or not indexed at all. @@ -2082,10 +2082,10 @@ Learn more [here](../indexes/indexing-related-documents.mdx). ## Indexing Missing Fields By default, indexes will not index a document that contains none of the specified fields. This behavior can be changed -using the [Indexing.IndexEmptyEntries](../server/configuration/indexing-configuration.mdx#indexing.indexemptyentries) +using the [Indexing.IndexEmptyEntries](../server/configuration/indexing-configuration.mdx#indexingindexemptyentries) configuration option. -The option [Indexing.IndexMissingFieldsAsNull](../server/configuration/indexing-configuration.mdx#indexing.indexmissingfieldsasnull) +The option [Indexing.IndexMissingFieldsAsNull](../server/configuration/indexing-configuration.mdx#indexingindexmissingfieldsasnull) determines whether missing fields in documents are indexed with the value `null`, or not indexed at all. @@ -2869,10 +2869,10 @@ Learn more [here](../indexes/indexing-related-documents.mdx). ## Indexing Missing Fields By default, indexes will not index a document that contains none of the specified fields. This behavior can be changed -using the [Indexing.IndexEmptyEntries](../server/configuration/indexing-configuration.mdx#indexing.indexemptyentries) +using the [Indexing.IndexEmptyEntries](../server/configuration/indexing-configuration.mdx#indexingindexemptyentries) configuration option. -The option [Indexing.IndexMissingFieldsAsNull](../server/configuration/indexing-configuration.mdx#indexing.indexmissingfieldsasnull) +The option [Indexing.IndexMissingFieldsAsNull](../server/configuration/indexing-configuration.mdx#indexingindexmissingfieldsasnull) determines whether missing fields in documents are indexed with the value `null`, or not indexed at all. @@ -3246,10 +3246,10 @@ If a document relationship is represented by the document's ID, you can use the ## Indexing Missing Fields By default, indexes will not index a document that contains none of the specified fields. This behavior can be changed -using the [Indexing.IndexEmptyEntries](../server/configuration/indexing-configuration.mdx#indexing.indexemptyentries) +using the [Indexing.IndexEmptyEntries](../server/configuration/indexing-configuration.mdx#indexingindexemptyentries) configuration option. -The option [Indexing.IndexMissingFieldsAsNull](../server/configuration/indexing-configuration.mdx#indexing.indexmissingfieldsasnull) +The option [Indexing.IndexMissingFieldsAsNull](../server/configuration/indexing-configuration.mdx#indexingindexmissingfieldsasnull) determines whether missing fields in documents are indexed with the value `null`, or not indexed at all. diff --git a/versioned_docs/version-6.2/indexes/querying/exploration-queries.mdx b/versioned_docs/version-6.2/indexes/querying/exploration-queries.mdx index 645515e86c..540fbb6b9c 100644 --- a/versioned_docs/version-6.2/indexes/querying/exploration-queries.mdx +++ b/versioned_docs/version-6.2/indexes/querying/exploration-queries.mdx @@ -22,9 +22,9 @@ export const supportedLanguages = ["csharp", "python", "php", "nodejs"]; * **Exploration Queries** form an additional layer of filtering that can be applied - to a dataset after its retrieval by [Query](../../client-api/session/querying/how-to-query.mdx#session.query), - [DocumentQuery](../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery), - or [Raw RQL](../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery), + to a dataset after its retrieval by [Query](../../client-api/session/querying/how-to-query.mdx#sessionquery), + [DocumentQuery](../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery), + or [Raw RQL](../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery), while the dataset is still held by the server. * The **retrieved dataset** is scanned and filtered **without requiring or creating an @@ -347,7 +347,7 @@ filter_limit 100 * **Exploration Queries** form an additional layer of filtering that can be applied - to a dataset after its retrieval by [raw_rql](../../client-api/session/querying/how-to-query.mdx#session.advanced.raw_query), + to a dataset after its retrieval by [raw_rql](../../client-api/session/querying/how-to-query.mdx#sessionadvancedraw_query), while the dataset is still held by the server. * The **retrieved dataset** is scanned and filtered **without requiring or creating an @@ -578,7 +578,7 @@ filter_limit 100 * **Exploration Queries** form an additional layer of filtering that can be applied - to a dataset after its retrieval by [raw rql](../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery), + to a dataset after its retrieval by [raw rql](../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery), while the dataset is still held by the server. * The **retrieved dataset** is scanned and filtered **without requiring or creating an @@ -864,8 +864,8 @@ filter_limit 100 * **Exploration Queries** form an additional layer of filtering that can be applied - to a dataset after its retrieval by [query](../../client-api/session/querying/how-to-query.mdx#session.query), - or [rawQuery](../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery), + to a dataset after its retrieval by [query](../../client-api/session/querying/how-to-query.mdx#sessionquery), + or [rawQuery](../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery), while the dataset is still held by the server. * The **retrieved dataset** is scanned and filtered **without requiring or creating an index**, diff --git a/versioned_docs/version-6.2/indexes/querying/paging.mdx b/versioned_docs/version-6.2/indexes/querying/paging.mdx index c9894715ea..a7bc0a42b6 100644 --- a/versioned_docs/version-6.2/indexes/querying/paging.mdx +++ b/versioned_docs/version-6.2/indexes/querying/paging.mdx @@ -406,7 +406,7 @@ This practice has several benefits: * By default, if the number of returned results exceeds **2048**, the server will issue a "Page size too big" notification (visible in the Studio) with information about the query. -* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehints.maxnumberofresults) configuration key. +* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehintsmaxnumberofresults) configuration key. * As suggested by the hint, you may consider using [Streaming query results](../../client-api/session/querying/how-to-stream-query-results.mdx) instead of paging. @@ -967,7 +967,7 @@ This practice has several benefits: * By default, if the number of returned results exceeds **2048**, the server will issue a "Page size too big" notification (visible in the Studio) with information about the query. -* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehints.maxnumberofresults) configuration key. +* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehintsmaxnumberofresults) configuration key. * As suggested by the hint, you may consider using [Streaming query results](../../client-api/session/querying/how-to-stream-query-results.mdx) instead of paging. @@ -1336,7 +1336,7 @@ This practice has several benefits: * By default, if the number of returned results exceeds **2048**, the server will issue a "Page size too big" notification (visible in the Studio) with information about the query. -* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehints.maxnumberofresults) configuration key. +* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehintsmaxnumberofresults) configuration key. * As suggested by this performance hint, you may consider using [Streaming query results](../../client-api/session/querying/how-to-stream-query-results.mdx) instead of paging. @@ -1884,7 +1884,7 @@ This practice has several benefits: * By default, if the number of returned results exceeds **2048**, the server will issue a "Page size too big" notification (visible in the Studio) with information about the query. -* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehints.maxnumberofresults) configuration key. +* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehintsmaxnumberofresults) configuration key. * As suggested by this performance hint, you may consider using [Streaming query results](../../client-api/session/querying/how-to-stream-query-results.mdx) instead of paging. @@ -2430,7 +2430,7 @@ This practice has several benefits: * By default, if the number of returned results exceeds **2048**, the server will issue a "Page size too big" notification (visible in the Studio) with information about the query. -* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehints.maxnumberofresults) configuration key. +* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehintsmaxnumberofresults) configuration key. * As suggested by the hint, you may consider using [Streaming query results](../../client-api/session/querying/how-to-stream-query-results.mdx) instead of paging. diff --git a/versioned_docs/version-6.2/indexes/querying/query-index.mdx b/versioned_docs/version-6.2/indexes/querying/query-index.mdx index 09c678c5af..71f4378142 100644 --- a/versioned_docs/version-6.2/indexes/querying/query-index.mdx +++ b/versioned_docs/version-6.2/indexes/querying/query-index.mdx @@ -478,8 +478,8 @@ where LastName == "King" ## Query an index by `RawQuery` -* Queries defined with [Query](../../indexes/querying/query-index.mdx#session.query) - or [DocumentQuery](../../indexes/querying/query-index.mdx#session.advanced.documentquery) +* Queries defined with [Query](../../indexes/querying/query-index.mdx#sessionquery) + or [DocumentQuery](../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) are translated by the RavenDB client to [RQL](../../client-api/session/querying/what-is-rql.mdx) when sent to the server. @@ -1007,8 +1007,8 @@ limit 5, 10 // skip 5, take 10 ## Query an index by `raw_query` -* Queries defined with [Query](../../indexes/querying/query-index.mdx#session.query) - or [DocumentQuery](../../indexes/querying/query-index.mdx#session.advanced.documentquery) +* Queries defined with [Query](../../indexes/querying/query-index.mdx#sessionquery) + or [DocumentQuery](../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) are translated by the RavenDB client to [RQL](../../client-api/session/querying/what-is-rql.mdx) when sent to the server. @@ -1520,8 +1520,8 @@ where LastName == "King" ## Query an index by `rawQuery` -* Queries defined with [Query](../../indexes/querying/query-index.mdx#session.query) - or [DocumentQuery](../../indexes/querying/query-index.mdx#session.advanced.documentquery) +* Queries defined with [Query](../../indexes/querying/query-index.mdx#sessionquery) + or [DocumentQuery](../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) are translated by the RavenDB client to [RQL](../../client-api/session/querying/what-is-rql.mdx) when sent to the server. @@ -1890,7 +1890,7 @@ limit 5, 10 // skip 5, take 10 ## Query an index by `RawQuery` -* Queries defined with [query](../../indexes/querying/query-index.mdx#session.query) 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](../../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. * 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/rolling-index-deployment.mdx b/versioned_docs/version-6.2/indexes/rolling-index-deployment.mdx index 907fb4f1c1..dd67018bd6 100644 --- a/versioned_docs/version-6.2/indexes/rolling-index-deployment.mdx +++ b/versioned_docs/version-6.2/indexes/rolling-index-deployment.mdx @@ -89,7 +89,7 @@ Nodes are assigned with the indexing of each database in a linear order, one nod ## Setting Indexing Deployment Mode ### Server-Wide Deployment Mode - Deployment mode can be set server-wide using [configuration options](../server/configuration/configuration-options.mdx#settings.json). + Deployment mode can be set server-wide using [configuration options](../server/configuration/configuration-options.mdx#settingsjson). Setting the server-wide configuration option will apply to all databases on a given node. * [Auto Indexes](../indexes/creating-and-deploying.mdx#auto-indexes) Deployment Mode 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 0dfd99ec01..b13bca68df 100644 --- a/versioned_docs/version-6.2/indexes/search-engine/corax.mdx +++ b/versioned_docs/version-6.2/indexes/search-engine/corax.mdx @@ -63,17 +63,17 @@ import LanguageContent from "@site/src/components/LanguageContent"; * These configuration options are available: - * [Indexing.Auto.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexing.auto.searchenginetype) + * [Indexing.Auto.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexingautosearchenginetype) Use this option to select the search engine (either `Lucene` or `Corax`) for **auto** indexes. The search engine can be selected **server-wide** or **per database**. - * [Indexing.Static.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexing.static.searchenginetype) + * [Indexing.Static.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexingstaticsearchenginetype) Use this option to select the search engine (either `Lucene` or `Corax`) for **static** indexes. The search engine can be selected **server-wide**, **per database**, or **per index**. * Read about additional Corax configuration options [here](../../indexes/search-engine/corax.mdx#configuration-options). ### Select search engine: Server wide Select the search engine for all the databases hosted by a server -by modifying the server's [settings.json](../../server/configuration/configuration-options.mdx#settings.json) file. +by modifying the server's [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) file. E.g. - @@ -397,7 +397,7 @@ a static index. * **New static index** (created or reset on RavenDB `6.2.x` and on) The index will behave as determined by the - [Indexing.Corax.Static.ComplexFieldIndexingBehavior](../../server/configuration/indexing-configuration.mdx#indexing.corax.static.complexfieldindexingbehavior) + [Indexing.Corax.Static.ComplexFieldIndexingBehavior](../../server/configuration/indexing-configuration.mdx#indexingcoraxstaticcomplexfieldindexingbehavior) configuration option. * If `ComplexFieldIndexingBehavior` is set to **`Throw`** - Corax will throw a `NotSupportedInCoraxException` exception with this message: @@ -519,39 +519,39 @@ order by Location Corax configuration options include: -* [Indexing.Auto.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexing.auto.searchenginetype) +* [Indexing.Auto.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexingautosearchenginetype) [Select](../../indexes/search-engine/corax.mdx#selecting-the-search-engine) the search engine for **Auto** indexes. -* [Indexing.Static.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexing.static.searchenginetype) +* [Indexing.Static.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexingstaticsearchenginetype) [Select](../../indexes/search-engine/corax.mdx#selecting-the-search-engine) the search engine for **Static** indexes. -* [Indexing.Corax.IncludeDocumentScore](../../server/configuration/indexing-configuration.mdx#indexing.corax.includedocumentscore) +* [Indexing.Corax.IncludeDocumentScore](../../server/configuration/indexing-configuration.mdx#indexingcoraxincludedocumentscore) Choose whether to include the score value in document metadata when sorting by score. Disabling this option can improve query performance. -* [Indexing.Corax.IncludeSpatialDistance](../../server/configuration/indexing-configuration.mdx#indexing.corax.includespatialdistance) +* [Indexing.Corax.IncludeSpatialDistance](../../server/configuration/indexing-configuration.mdx#indexingcoraxincludespatialdistance) Choose whether to include spatial information in document metadata when sorting by distance. Disabling this option can improve query performance. -* [Indexing.Corax.MaxMemoizationSizeInMb](../../server/configuration/indexing-configuration.mdx#indexing.corax.maxmemoizationsizeinmb) +* [Indexing.Corax.MaxMemoizationSizeInMb](../../server/configuration/indexing-configuration.mdx#indexingcoraxmaxmemoizationsizeinmb) The maximum amount of memory that Corax can use for a memoization clause during query processing. Please configure this option only if you are an expert. -* [Indexing.Corax.DocumentsLimitForCompressionDictionaryCreation](../../server/configuration/indexing-configuration.mdx#indexing.corax.documentslimitforcompressiondictionarycreation) +* [Indexing.Corax.DocumentsLimitForCompressionDictionaryCreation](../../server/configuration/indexing-configuration.mdx#indexingcoraxdocumentslimitforcompressiondictionarycreation) Set the maximum number of documents that will be used for the training of a Corax index during dictionary creation. Training will stop when it reaches this limit. -* [Indexing.Corax.MaxAllocationsAtDictionaryTrainingInMb](../../server/configuration/indexing-configuration.mdx#indexing.corax.maxallocationsatdictionarytraininginmb) +* [Indexing.Corax.MaxAllocationsAtDictionaryTrainingInMb](../../server/configuration/indexing-configuration.mdx#indexingcoraxmaxallocationsatdictionarytraininginmb) Set the maximum amount of memory (in MB) that will be allocated for the training of a Corax index during dictionary creation. Training will stop when it reaches this limit. -* [Indexing.Corax.Static.ComplexFieldIndexingBehavior](../../server/configuration/indexing-configuration.mdx#indexing.corax.static.complexfieldindexingbehavior) +* [Indexing.Corax.Static.ComplexFieldIndexingBehavior](../../server/configuration/indexing-configuration.mdx#indexingcoraxstaticcomplexfieldindexingbehavior) Choose [how to react](../../indexes/search-engine/corax.mdx#if-corax-encounters-a-complex-property-while-indexing) when a static Corax index is requested to index a complex JSON object. @@ -578,14 +578,14 @@ Here are some additional things to keep in mind about Corax indexes compression * The benefits of compression dictionaries are most pronounced for large collections. Training stops when it reaches either the - [number of documents](../../server/configuration/indexing-configuration.mdx#indexing.corax.documentslimitforcompressiondictionarycreation) + [number of documents](../../server/configuration/indexing-configuration.mdx#indexingcoraxdocumentslimitforcompressiondictionarycreation) threshold (100,000 docs by default) or the - [amount of memory](../../server/configuration/indexing-configuration.mdx#indexing.corax.maxallocationsatdictionarytraininginmb) + [amount of memory](../../server/configuration/indexing-configuration.mdx#indexingcoraxmaxallocationsatdictionarytraininginmb) threshold (up to 2GB). Both thresholds are configurable. * If upon creation there are less than 10,000 documents in the involved collections, it may make sense to manually force an index reset after reaching - [100,000](../../server/configuration/indexing-configuration.mdx#indexing.corax.documentslimitforcompressiondictionarycreation) + [100,000](../../server/configuration/indexing-configuration.mdx#indexingcoraxdocumentslimitforcompressiondictionarycreation) documents to force retraining. Indexes are replaced in a [side-by-side](../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---side-by-side-indexing) diff --git a/versioned_docs/version-6.2/indexes/using-analyzers.mdx b/versioned_docs/version-6.2/indexes/using-analyzers.mdx index 326691a899..bbfd4038e1 100644 --- a/versioned_docs/version-6.2/indexes/using-analyzers.mdx +++ b/versioned_docs/version-6.2/indexes/using-analyzers.mdx @@ -281,7 +281,7 @@ There are two exceptions to this rule: 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: - * Increase the [MaxGram](../server/configuration/indexing-configuration.mdx#indexing.lucene.analyzers.ngram.maxgram) value to generate larger tokens during indexing (when using Lucene). + * Increase the [MaxGram](../server/configuration/indexing-configuration.mdx#indexingluceneanalyzersngrammaxgram) value to generate larger tokens during indexing (when using Lucene). * Use a different analyzer other than _NGramAnalyzer_ that better matches your requirements. 2. Behavior is also different when making a full-text search with wildcards in the search terms. @@ -459,8 +459,8 @@ All examples below use the following text: * **Overriding default token length**: (only when using Lucene as the search engine) You can override the default token lengths of the NGram analyzer by setting the following configuration keys: - [Indexing.Lucene.Analyzers.NGram.MinGram](../server/configuration/indexing-configuration.mdx#indexing.lucene.analyzers.ngram.mingram) - and [Indexing.Lucene.Analyzers.NGram.MaxGram](../server/configuration/indexing-configuration.mdx#indexing.lucene.analyzers.ngram.maxgram). + [Indexing.Lucene.Analyzers.NGram.MinGram](../server/configuration/indexing-configuration.mdx#indexingluceneanalyzersngrammingram) + and [Indexing.Lucene.Analyzers.NGram.MaxGram](../server/configuration/indexing-configuration.mdx#indexingluceneanalyzersngrammaxgram). For example, setting them to 3 and 4, respectively, will generate the following tokens: @@ -577,7 +577,7 @@ store.Maintenance.Send(new PutIndexesOperation(indexDefinition)); By default, this analyzer is the `RavenStandardAnalyzer` (inherits from Lucene's _StandardAnalyzer_). * To customize a different analyzer that will serve as your Default Search Analyzer, - set the [Indexing.Analyzers.Search.Default](../server/configuration/indexing-configuration.mdx#indexing.analyzers.search.default) configuration key. + set the [Indexing.Analyzers.Search.Default](../server/configuration/indexing-configuration.mdx#indexinganalyzerssearchdefault) configuration key. * Using a search analyzer enables full-text search queries against the field. Given the same sample text from above, _RavenStandardAnalyzer_ will produce the following tokens: @@ -623,7 +623,7 @@ store.Maintenance.Send(new PutIndexesOperation(indexDefinition)); The field's value is indexed exactly as provided, enabling precise, case-sensitive matching at query time. * To customize a different analyzer that will serve as your Default Exact Analyzer, - set the [Indexing.Analyzers.Exact.Default ](../server/configuration/indexing-configuration.mdx#indexing.analyzers.exact.default) configuration key. + set the [Indexing.Analyzers.Exact.Default ](../server/configuration/indexing-configuration.mdx#indexinganalyzersexactdefault) configuration key. * Given the same sample text from above, _KeywordAnalyzer_ will produce a single token: `[The quick brown fox jumped over the lazy dogs, Bob@hotmail.com 123432.]` @@ -666,7 +666,7 @@ store.Maintenance.Send(new PutIndexesOperation(indexDefinition)); The entire content of the field is processed into a single, lowercased token. * To customize a different analyzer that will serve as your Default Analyzer, - set the [Indexing.Analyzers.Default](../server/configuration/indexing-configuration.mdx#indexing.analyzers.default) configuration key. + set the [Indexing.Analyzers.Default](../server/configuration/indexing-configuration.mdx#indexinganalyzersdefault) configuration key. * Given the same sample text from above, _LowerCaseKeywordAnalyzer_ will produce a single token: `[the quick brown fox jumped over the lazy dogs, bob@hotmail.com 123432.]` @@ -970,7 +970,7 @@ There are two exceptions to this rule: 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: - * Increase the [MaxGram](../server/configuration/indexing-configuration.mdx#indexing.lucene.analyzers.ngram.maxgram) value to generate larger tokens during indexing (when using Lucene). + * Increase the [MaxGram](../server/configuration/indexing-configuration.mdx#indexingluceneanalyzersngrammaxgram) value to generate larger tokens during indexing (when using Lucene). * Use a different analyzer other than _NGramAnalyzer_ that better matches your requirements. 2. Behavior is also different when making a full-text search with wildcards in the search terms. @@ -1148,8 +1148,8 @@ All examples below use the following text: * **Overriding default token length**: (only when using Lucene as the search engine) You can override the default token lengths of the NGram analyzer by setting the following configuration keys: - [Indexing.Lucene.Analyzers.NGram.MinGram](../server/configuration/indexing-configuration.mdx#indexing.lucene.analyzers.ngram.mingram) - and [Indexing.Lucene.Analyzers.NGram.MaxGram](../server/configuration/indexing-configuration.mdx#indexing.lucene.analyzers.ngram.maxgram). + [Indexing.Lucene.Analyzers.NGram.MinGram](../server/configuration/indexing-configuration.mdx#indexingluceneanalyzersngrammingram) + and [Indexing.Lucene.Analyzers.NGram.MaxGram](../server/configuration/indexing-configuration.mdx#indexingluceneanalyzersngrammaxgram). For example, setting them to 3 and 4, respectively, will generate the following tokens: @@ -1250,7 +1250,7 @@ await store.maintenance By default, this analyzer is the `RavenStandardAnalyzer` (inherits from Lucene's _StandardAnalyzer_). * To customize a different analyzer that will serve as your Default Search Analyzer, - set the [Indexing.Analyzers.Search.Default](../server/configuration/indexing-configuration.mdx#indexing.analyzers.search.default) configuration key. + set the [Indexing.Analyzers.Search.Default](../server/configuration/indexing-configuration.mdx#indexinganalyzerssearchdefault) configuration key. * Using a search analyzer enables full-text search queries against the field. Given the same sample text from above, _RavenStandardAnalyzer_ will produce the following tokens: @@ -1293,7 +1293,7 @@ await store.maintenance The field's value is indexed exactly as provided, enabling precise, case-sensitive matching at query time. * To customize a different analyzer that will serve as your Default Exact Analyzer, - set the [Indexing.Analyzers.Exact.Default ](../server/configuration/indexing-configuration.mdx#indexing.analyzers.exact.default) configuration key. + set the [Indexing.Analyzers.Exact.Default ](../server/configuration/indexing-configuration.mdx#indexinganalyzersexactdefault) configuration key. * Given the same sample text from above, _KeywordAnalyzer_ will produce a single token: `[The quick brown fox jumped over the lazy dogs, Bob@hotmail.com 123432.]` @@ -1334,7 +1334,7 @@ await store.maintenance The entire content of the field is processed into a single, lowercased token. * To customize a different analyzer that will serve as your Default Analyzer, - set the [Indexing.Analyzers.Default](../server/configuration/indexing-configuration.mdx#indexing.analyzers.default) configuration key. + set the [Indexing.Analyzers.Default](../server/configuration/indexing-configuration.mdx#indexinganalyzersdefault) configuration key. * Given the same sample text from above, _LowerCaseKeywordAnalyzer_ will produce a single token: `[the quick brown fox jumped over the lazy dogs, bob@hotmail.com 123432.]` 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 fe4176cb57..55b371bccc 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 @@ -19,7 +19,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * 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#akka.persistence.ravendb) + * [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) 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 c00f9cd25f..a5402e201a 100644 --- a/versioned_docs/version-6.2/integrations/postgresql-protocol/overview.mdx +++ b/versioned_docs/version-6.2/integrations/postgresql-protocol/overview.mdx @@ -47,7 +47,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; If your current license doesn't include Power BI Support, you can acquire one that does [here](https://ravendb.net/buy). ### Settings -* PostgreSQL protocol support must be explicitly enabled in your [settings](../../server/configuration/configuration-options.mdx#settings.json). +* PostgreSQL protocol support must be explicitly enabled in your [settings](../../server/configuration/configuration-options.mdx#settingsjson). Add this line to your server's `settings.json` file to enable the PostgreSQL protocol: @@ -56,7 +56,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * PostgreSQL is an experimental feature. To enable it, enable RavenDB's - [Experimental Features](../../server/configuration/core-configuration.mdx#features.availability) + [Experimental Features](../../server/configuration/core-configuration.mdx#featuresavailability) by adding this line to your server's `settings.json` file: 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 15989a05aa..9d99583933 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 @@ -21,7 +21,7 @@ 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) - * [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-(&&)) + * [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) 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 5c14482357..9007ebfdd0 100644 --- a/versioned_docs/version-6.2/migration/server/data-migration.mdx +++ b/versioned_docs/version-6.2/migration/server/data-migration.mdx @@ -16,9 +16,9 @@ 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-5.x-to-6.x) - * [Migration from RavenDB 4.x to RavenDB 5.x and 6.x](../../migration/server/data-migration.mdx#migration-from-ravendb-4.x-to-ravendb-5.x-and-6.x) - * [Migration from RavenDB 3.x](../../migration/server/data-migration.mdx#migration-from-ravendb-3.x) + * [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) @@ -27,7 +27,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * RavenDB `6.x` supports in-place migration of data from RavenDB `5.x`. * RavenDB `5.x` product licenses **do not apply** to RavenDB `6.x`. To upgrade a valid `5.x` license to a RavenDB `6.x` license, - please use the **License upgrade tool** [as explained here](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6.x). + please use the **License upgrade tool** [as explained here](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6x). Please note that once upgraded, RavenDB `6.x` cannot be downgraded to version `5.x`, @@ -46,7 +46,7 @@ and the migrated data will no longer be accessible via RavenDB `5.x`. * RavenDB `4.x` product licenses **do not apply** to RavenDB `6.x`. To upgrade a valid `4.x` license to a RavenDB `6.x` license, - please use the **License upgrade tool** [as explained here](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6.x). + please use the **License upgrade tool** [as explained here](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6x). Please note that once upgraded, RavenDB `6.x` cannot be downgraded to version `4.x`, diff --git a/versioned_docs/version-6.2/migration/server/docker.mdx b/versioned_docs/version-6.2/migration/server/docker.mdx index ce699c3d4f..71f5b23e88 100644 --- a/versioned_docs/version-6.2/migration/server/docker.mdx +++ b/versioned_docs/version-6.2/migration/server/docker.mdx @@ -26,8 +26,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Read [here](../../start/containers/image-usage.mdx) more about running a RavenDB Docker image. * In this page: - * [Changes Made In RavenDB `6.0` And Up](../../migration/server/docker.mdx#changes-made-in-ravendb-6.0-and-up) - * [Migrating To `6.0` And Up](../../migration/server/docker.mdx#migrating-to-6.0-and-up) + * [Changes Made In RavenDB `6.0` And Up](../../migration/server/docker.mdx#changes-made-in-ravendb-60-and-up) + * [Migrating To `6.0` And Up](../../migration/server/docker.mdx#migrating-to-60-and-up) ## Changes Made In RavenDB 6.0 And Up 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 c283b966f5..8d266f3e72 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 @@ -73,7 +73,7 @@ remains unchanged). * The configuration option will apply only to [new static indexes](../../indexes/search-engine/corax.mdx#if-corax-encounters-a-complex-property-while-indexing), created after the release of RavenDB `6.2`. It will not affect older indexes. -* [ComplexFieldIndexingBehavior](../../server/configuration/indexing-configuration.mdx#indexing.corax.static.complexfieldindexingbehavior) +* [ComplexFieldIndexingBehavior](../../server/configuration/indexing-configuration.mdx#indexingcoraxstaticcomplexfieldindexingbehavior) can be set for a particular index as well as for all indexes. * Though complex fields cannot be indexed, they **can** still be [stored and projected](../../indexes/search-engine/corax.mdx#revise-index-definition-and-fields-usage). * To search by the contents of a static index's complex field, you can convert diff --git a/versioned_docs/version-6.2/server/administration/cli.mdx b/versioned_docs/version-6.2/server/administration/cli.mdx index 551f52dce0..ffb0be8707 100644 --- a/versioned_docs/version-6.2/server/administration/cli.mdx +++ b/versioned_docs/version-6.2/server/administration/cli.mdx @@ -82,7 +82,7 @@ Enable (or disable) online log printing to the console. | ------------- | ------------- | | `on` or `off` | enables or disables log printing | | `http-on` or `http-off` | enables or disables HTTP request log information | -| `none`, `operations` or `information` | sets the log mode to desired [level](../../server/configuration/logs-configuration.mdx#logs.mode) | +| `none`, `operations` or `information` | sets the log mode to desired [level](../../server/configuration/logs-configuration.mdx#logsmode) | 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 3e89269403..8aae6d4505 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 @@ -43,7 +43,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ## Enabling OpenTelemetry in RavenDB * To enable the OpenTelemetry metrics in RavenDB, - you **must** first set the [Monitoring.OpenTelemetry.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.enabled) configuration key to _true_. + you **must** first set the [Monitoring.OpenTelemetry.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryenabled) configuration key to _true_. * Learn how to customize configuration keys in the [Configuration Overview](../../../server/configuration/configuration-options.mdx) article, which outlines all available options. @@ -65,41 +65,41 @@ RavenDB exposes the following meters: * **ravendb.server.cpucredits** Description: Exposes status of CPU credits (cloud) Enabled by default: _false_ - Configuration key: [Monitoring.OpenTelemetry.Meters.Server.CPUCredits.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.cpucredits.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.Server.CPUCredits.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersservercpucreditsenabled) * **ravendb.server.gc** Description: Exposes detailed information about the Garbage Collector Enabled by default: _false_ - Configuration key: [Monitoring.OpenTelemetry.Meters.Server.GC.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.gc.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.Server.GC.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersservergcenabled) * **ravendb.server.general** Description: Exposes general info about the cluster and its licensing Enabled by default: _true_ - Configuration key: [Monitoring.OpenTelemetry.Meters.Server.General.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.general.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.Server.General.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersservergeneralenabled) * **ravendb.server.requests** Description: Exposes information about requests processed by server Enabled by default: _true_ - Configuration key: [Monitoring.OpenTelemetry.Meters.Server.Requests.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.requests.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.Server.Requests.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersserverrequestsenabled) * **ravendb.server.resources** Description: Exposes detailed information about resources usage (e.g. CPU etc.) Enabled by default: _true_ - Configuration key: [Monitoring.OpenTelemetry.Meters.Server.Resources.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.resources.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.Server.Resources.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersserverresourcesenabled) * **ravendb.server.storage** Description: Exposes storage information Enabled by default: _true_ - Configuration key: [Monitoring.OpenTelemetry.Meters.Server.Storage.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.storage.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.Server.Storage.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersserverstorageenabled) * **ravendb.server.totaldatabases** Description: Exposes aggregated information about databases on the server Enabled by default: _true_ - Configuration key: [Monitoring.OpenTelemetry.Meters.Server.TotalDatabases.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.totaldatabases.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.Server.TotalDatabases.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersservertotaldatabasesenabled) RavenDB also supports exposing meters developed by Microsoft for AspNetCore and .NET Runtime: * **Official AspNetCore instrumentation** Description: See the official MS documentation [AspNetCore documentation](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/main/src/OpenTelemetry.Instrumentation.AspNetCore/README.md#metrics) Enabled by default: _false_ - Configuration key: [Monitoring.OpenTelemetry.Meters.AspNetCore.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.aspnetcore.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.AspNetCore.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersaspnetcoreenabled) * **Official Runtime instrumentation** Description: See the official MS documentation [.NET Runtime documentation](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/tree/main/src/OpenTelemetry.Instrumentation.Runtime#metrics) Enabled by default: _false_ - Configuration key: [Monitoring.OpenTelemetry.Meters.Runtime.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.runtime.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.Runtime.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersruntimeenabled) @@ -112,7 +112,7 @@ RavenDB also supports exposing meters developed by Microsoft for AspNetCore and * The server instance identification is determined by the following sequence: 1. **Configuration Key** - First, attempt to retrieve the [Monitoring.OpenTelemetry.ServiceInstanceId](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.serviceinstanceid) configuration key. + First, attempt to retrieve the [Monitoring.OpenTelemetry.ServiceInstanceId](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryserviceinstanceid) configuration key. 2. **Public URL Hostname** If the configuration key is Not defined, use the server's public URL hostname, provided it is available. 3. **Node Tag** @@ -257,7 +257,7 @@ RavenDB offers two options for exporting metrics: as it eliminates the need for integration with external monitoring systems or observability platforms. * To enable output to the console - - set the [Monitoring.OpenTelemetry.ConsoleExporter](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.consoleexporter) configuration key to _true_. + set the [Monitoring.OpenTelemetry.ConsoleExporter](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryconsoleexporter) configuration key to _true_. @@ -274,18 +274,18 @@ RavenDB offers two options for exporting metrics: * RavenDB supports the official OTLP by default, allowing you to export RavenDB metrics to the OpenTelemetry Collector. * To enable exporting metrics via the OpenTelemetry Protocol - - set the [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.enabled) configuration key to _true_. + set the [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolenabled) configuration key to _true_. * By default, RavenDB does not override the OpenTelemetry Protocol exporter default values. However, customization is available via the following configuration options: | Configuration key | Description | Accepted values | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| -| Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.ExportProcessorType](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.exportprocessortype) | Export processor type | Simple / Batch | -| Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Headers](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.headers) | Custom headers | string | -| Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Protocol](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.protocol) | Defines the transport protocol that OpenTelemetry Protocol should use to send data. | gRPC / HttpProtobuf | -| Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Endpoint](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.endpoint) | Endpoint where OpenTelemetry Protocol should send data.
See configuration details [below](../../../server/administration/monitoring/open-telemetry.mdx#configure-endpoint). | string | -| Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Timeout](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.timeout) | Timeout | int | +| 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
[.Timeout](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocoltimeout) | Timeout | int | 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 f1ef35a2d4..6c09417430 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 @@ -57,7 +57,7 @@ SNMP support is available for [Enterprise](../../../start/licensing/licensing-ov ## Enabling SNMP in RavenDB -* To monitor RavenDB using SNMP you __must__ first set the [Monitoring.Snmp.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.enabled) configuration key to _true_. +* To monitor RavenDB using SNMP you __must__ first set the [Monitoring.Snmp.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpenabled) configuration key to _true_. * To learn how to modify a configuration key, refer to the [Configuration Overview](../../../server/configuration/configuration-options.mdx) article, which outlines all available options. @@ -82,36 +82,36 @@ SNMP support is available for [Enterprise](../../../start/licensing/licensing-ov There are several configurable SNMP properties in RavenDB: ##### For SNMPv1: -* [Monitoring.Snmp.Port](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.port) +* [Monitoring.Snmp.Port](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpport) The SNMP port. Default: `161` -* [Monitoring.Snmp.SupportedVersions](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.supportedversions) +* [Monitoring.Snmp.SupportedVersions](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpsupportedversions) List of supported SNMP versions. Default: `"V2C;V3"` ##### For SNMPv2c: -* [Monitoring.Snmp.Community](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.community) +* [Monitoring.Snmp.Community](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpcommunity) The community string is used as a password. It is sent with each SNMP `GET` request and allows or denies access to the monitored device. Default: `"ravendb"` ##### For SNMPv3: -* [Monitoring.Snmp.AuthenticationProtocol](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationprotocol) +* [Monitoring.Snmp.AuthenticationProtocol](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationprotocol) Authentication protocol. Default: `"SHA1"` -* [Monitoring.Snmp.AuthenticationUser](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationuser) +* [Monitoring.Snmp.AuthenticationUser](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationuser) The user for authentication. Default: `"ravendb"` -* [Monitoring.Snmp.AuthenticationPassword](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationpassword) +* [Monitoring.Snmp.AuthenticationPassword](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationpassword) The authentication password. When set to `null` the community string is used instead. Default: `null` -* [Monitoring.Snmp.PrivacyProtocol](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.privacyprotocol) +* [Monitoring.Snmp.PrivacyProtocol](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpprivacyprotocol) Privacy protocol. Default: `None` -* [Monitoring.Snmp.PrivacyPassword](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.privacypassword) +* [Monitoring.Snmp.PrivacyPassword](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpprivacypassword) Privacy password. Default: `"ravendb"` @@ -145,7 +145,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#1.3). + 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 SNMPv2c: @@ -160,7 +160,7 @@ iso.3.6.1.4.1.45751.1.1.1.3 = Timeticks: (29543973) 3 days, 10:03:59.73 - * `ravendb` is the community string (set via the [Monitoring.Snmp.Community](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.community) configuration key). + * `ravendb` is the community string (set via the [Monitoring.Snmp.Community](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpcommunity) configuration key). * `"live-test.ravendb.net"` is the host. ##### For SNMPv3: @@ -189,7 +189,7 @@ __Access single OID value__: * 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#1.3): +* For example, a cURL request for the server [up-time metric](../../../server/administration/snmp/snmp-overview.mdx#13): @@ -206,7 +206,7 @@ __Access multiple OID values__: * 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#1.6.7) and [unmanaged memory](../../../server/administration/snmp/snmp-overview.mdx#1.6.8) metrics: +* 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: 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 682ee0755e..44d14439b6 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 @@ -30,8 +30,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * To maintain the Replication Factor, every newly elected [Leader](../../../server/clustering/rachis/cluster-topology.mdx#leader) starts measuring the health of each node by creating dedicated maintenance TCP connections to all other nodes in the cluster. -* Each node reports the current status of _all_ its databases at intervals of [500 milliseconds](../../../server/configuration/cluster-configuration.mdx#cluster.workersampleperiodinms) (by default). - The `Cluster Observer` consumes those reports every [1000 milliseconds](../../../server/configuration/cluster-configuration.mdx#cluster.supervisorsampleperiodinms) (by default). +* Each node reports the current status of _all_ its databases at intervals of [500 milliseconds](../../../server/configuration/cluster-configuration.mdx#clusterworkersampleperiodinms) (by default). + The `Cluster Observer` consumes those reports every [1000 milliseconds](../../../server/configuration/cluster-configuration.mdx#clustersupervisorsampleperiodinms) (by default). * Upon a **node failure**, the [Dynamic Database Distribution](../../../server/clustering/distribution/distributed-database.mdx#dynamic-database-distribution) sequence will take place in order to ensure that the `Replication Factor` does not change. @@ -49,11 +49,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * If node C goes offline or becomes unreachable, the Cluster Observer detects the issue. Initially: - * After the duration specified in the [Cluster.TimeBeforeMovingToRehabInSec](../../../server/configuration/cluster-configuration.mdx#cluster.timebeforemovingtorehabinsec) configuration, + * After the duration specified in the [Cluster.TimeBeforeMovingToRehabInSec](../../../server/configuration/cluster-configuration.mdx#clustertimebeforemovingtorehabinsec) configuration, the observer moves node C to rehab mode, allowing time for recovery. * The ETL task fails over to another available node in the Database Group. - * If node C remains offline beyond the period specified in the [Cluster.TimeBeforeAddingReplicaInSec](../../../server/configuration/cluster-configuration.mdx#cluster.timebeforeaddingreplicainsec) configuration, + * If node C remains offline beyond the period specified in the [Cluster.TimeBeforeAddingReplicaInSec](../../../server/configuration/cluster-configuration.mdx#clustertimebeforeaddingreplicainsec) configuration, the observer begins replicating the database to another node in the Database Group as a last resort. 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 527c60e3d8..bb6aeb9415 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 @@ -101,10 +101,10 @@ All `Members` have master-master [Replication](../../../server/clustering/replic If any of the `Database Nodes` is down or partitioned, the [Cluster Observer](../../../server/clustering/distribution/cluster-observer.mdx) will recognize it and act as follows: -1. If the time that is defined in [TimeBeforeMovingToRehabInSec](../../../server/configuration/cluster-configuration.mdx#cluster.timebeforemovingtorehabinsec) (default: 60 seconds) has passed +1. If the time that is defined in [TimeBeforeMovingToRehabInSec](../../../server/configuration/cluster-configuration.mdx#clustertimebeforemovingtorehabinsec) (default: 60 seconds) has passed and the node is still unreachable, the node will be moved to a `Rehab` state. -2. If the node remains in `Rehab` for the time defined in [TimeBeforeAddingReplicaInSec](../../../server/configuration/cluster-configuration.mdx#cluster.timebeforeaddingreplicainsec) (default: 900 seconds), +2. If the node remains in `Rehab` for the time defined in [TimeBeforeAddingReplicaInSec](../../../server/configuration/cluster-configuration.mdx#clustertimebeforeaddingreplicainsec) (default: 900 seconds), a new database node will be automatically added to the database group to replace the `Rehab` node. 3. If the `Rehab` node is online again, it will be assigned a [Mentor Node](../../../server/clustering/distribution/highly-available-tasks.mdx#responsible-node) to update it with the recent changes. 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 3aeaa0a193..c0625bcdf3 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 @@ -129,7 +129,7 @@ The failover of a task to another responsible node can be prevented by **pinning * If the node the task is pinned to fails, the task will **not** be executed until the node is back online. When the node awakes, the task will be resumed from the failure point on. * If a node remains offline for the period set by - [cluster.timebeforeaddingreplicainsec](../../../server/configuration/cluster-configuration.mdx#cluster.timebeforeaddingreplicainsec), + [cluster.timebeforeaddingreplicainsec](../../../server/configuration/cluster-configuration.mdx#clustertimebeforeaddingreplicainsec), the cluster observer will attempt to select an available node to replace it in the database group and redistribute the fallen node's tasks, including pinned ones, among database group members. A task can be pinned to a selected node via Studio or using code. 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 fc12abe0c9..a9491c3801 100644 --- a/versioned_docs/version-6.2/server/configuration/backup-configuration.mdx +++ b/versioned_docs/version-6.2/server/configuration/backup-configuration.mdx @@ -17,16 +17,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Configuration options for backups (both on premise and RavenDB Cloud). -* Another relevant server configuration option can be found [here](../../server/configuration/server-configuration.mdx#server.cpucredits.exhaustionbackupdelayinmin). +* 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#backup.temppath) - * [Backup.LocalRootPath](../../server/configuration/backup-configuration.mdx#backup.localrootpath) - * [Backup.AllowedDestinations](../../server/configuration/backup-configuration.mdx#backup.alloweddestinations) - * [Backup.AllowedAwsRegions](../../server/configuration/backup-configuration.mdx#backup.allowedawsregions) - * [Backup.MaxNumberOfConcurrentBackups](../../server/configuration/backup-configuration.mdx#backup.maxnumberofconcurrentbackups) - * [Backup.ConcurrentBackupsDelayInSec](../../server/configuration/backup-configuration.mdx#backup.concurrentbackupsdelayinsec) - * [Backup.LowMemoryBackupDelayInMin](../../server/configuration/backup-configuration.mdx#backup.lowmemorybackupdelayinmin) + * [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.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 d2ccb1a07c..33f4068e4f 100644 --- a/versioned_docs/version-6.2/server/configuration/cluster-configuration.mdx +++ b/versioned_docs/version-6.2/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#cluster.compareexchangeexpireddeletefrequencyinsec) - [Cluster.CompareExchangeTombstonesCleanupIntervalInMin](../../server/configuration/cluster-configuration.mdx#cluster.compareexchangetombstonescleanupintervalinmin) - [Cluster.ElectionTimeoutInMs](../../server/configuration/cluster-configuration.mdx#cluster.electiontimeoutinms) - [Cluster.HardDeleteOnReplacement](../../server/configuration/cluster-configuration.mdx#cluster.harddeleteonreplacement) - [Cluster.LogHistoryMaxEntries](../../server/configuration/cluster-configuration.mdx#cluster.loghistorymaxentries) - [Cluster.MaxChangeVectorDistance](../../server/configuration/cluster-configuration.mdx#cluster.maxchangevectordistance) - [Cluster.MaxClusterTransactionCompareExchangeTombstoneCheckIntervalInMin](../../server/configuration/cluster-configuration.mdx#cluster.maxclustertransactioncompareexchangetombstonecheckintervalinmin) - [Cluster.MaxSizeOfSingleRaftCommandInMb](../../server/configuration/cluster-configuration.mdx#cluster.maxsizeofsingleraftcommandinmb) - [Cluster.MaximalAllowedClusterVersion](../../server/configuration/cluster-configuration.mdx#cluster.maximalallowedclusterversion) - [Cluster.OnErrorDelayTimeInMs](../../server/configuration/cluster-configuration.mdx#cluster.onerrordelaytimeinms) - [Cluster.OperationTimeoutInSec](../../server/configuration/cluster-configuration.mdx#cluster.operationtimeoutinsec) - [Cluster.ReceiveFromWorkerTimeoutInMs](../../server/configuration/cluster-configuration.mdx#cluster.receivefromworkertimeoutinms) - [Cluster.StatsStabilizationTimeInSec](../../server/configuration/cluster-configuration.mdx#cluster.statsstabilizationtimeinsec) - [Cluster.SupervisorSamplePeriodInMs](../../server/configuration/cluster-configuration.mdx#cluster.supervisorsampleperiodinms) - [Cluster.TcpReceiveBufferSizeInBytes](../../server/configuration/cluster-configuration.mdx#cluster.tcpreceivebuffersizeinbytes) - [Cluster.TcpSendBufferSizeInBytes](../../server/configuration/cluster-configuration.mdx#cluster.tcpsendbuffersizeinbytes) - [Cluster.TcpTimeoutInMs](../../server/configuration/cluster-configuration.mdx#cluster.tcptimeoutinms) - [Cluster.TimeBeforeAddingReplicaInSec](../../server/configuration/cluster-configuration.mdx#cluster.timebeforeaddingreplicainsec) - [Cluster.TimeBeforeMovingToRehabInSec](../../server/configuration/cluster-configuration.mdx#cluster.timebeforemovingtorehabinsec) - [Cluster.TimeBeforeRotatingPreferredNodeInSec](../../server/configuration/cluster-configuration.mdx#cluster.timebeforerotatingpreferrednodeinsec) - [Cluster.WorkerSamplePeriodInMs](../../server/configuration/cluster-configuration.mdx#cluster.workersampleperiodinms) + [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) * Server-wide, or database scope: - [Cluster.DisableAtomicDocumentWrites](../../server/configuration/cluster-configuration.mdx#cluster.disableatomicdocumentwrites) - [Cluster.MaxClusterTransactionBatchSize](../../server/configuration/cluster-configuration.mdx#cluster.maxclustertransactionbatchsize) + [Cluster.DisableAtomicDocumentWrites](../../server/configuration/cluster-configuration.mdx#clusterdisableatomicdocumentwrites) + [Cluster.MaxClusterTransactionBatchSize](../../server/configuration/cluster-configuration.mdx#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 41d4b879da..9b8932b1bf 100644 --- a/versioned_docs/version-6.2/server/configuration/configuration-options.mdx +++ b/versioned_docs/version-6.2/server/configuration/configuration-options.mdx @@ -20,7 +20,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * 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#settings.json) + * [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) @@ -36,7 +36,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * The server will retrieve these environment variables and apply their values. -To set the [Security.Certificate.Path](../../server/configuration/security-configuration.mdx#security.certificate.path) +To set the [Security.Certificate.Path](../../server/configuration/security-configuration.mdx#securitycertificatepath) configuration key using an environment variable, add the environment variable `RAVEN_Security_Certificate_Path`. @@ -84,7 +84,7 @@ _settings.json_ configuration values **override** their matching Configuration options that include multiple values (like strings separated by `;`) can be configured using regular JSON arrays. -To set [Security.WellKnownCertificates.Admin](../../server/configuration/security-configuration.mdx#security.wellknowncertificates.admin), +To set [Security.WellKnownCertificates.Admin](../../server/configuration/security-configuration.mdx#securitywellknowncertificatesadmin), for example, use: @@ -104,7 +104,7 @@ 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#settings.json) values. +and [settings.json](../../server/configuration/configuration-options.mdx#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/core-configuration.mdx b/versioned_docs/version-6.2/server/configuration/core-configuration.mdx index d91c0fcf2d..67534168b9 100644 --- a/versioned_docs/version-6.2/server/configuration/core-configuration.mdx +++ b/versioned_docs/version-6.2/server/configuration/core-configuration.mdx @@ -14,7 +14,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; # Configuration: Core -[settings.json](../../server/configuration/configuration-options.mdx#settings.json) variables change your server's behavior in various ways. +[settings.json](../../server/configuration/configuration-options.mdx#settingsjson) variables change your server's behavior in various ways. RavenDB reads `settings.json` only during startup. @@ -283,7 +283,7 @@ The URLs which the server should contact when requesting certificates from using ## Features.Availability -This [settings.json](../../server/configuration/configuration-options.mdx#settings.json) variable determines whether to run RavenDB with its standard +This [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) variable determines whether to run RavenDB with its standard features set, or add to a set of experimental features. Some features, like ones recently released, are considered **experimental**. They are disabled by default, you can enable them by setting `Features.Availability` to `Experimental`. 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 3ce2e86d4c..1838a18f08 100644 --- a/versioned_docs/version-6.2/server/configuration/database-configuration.mdx +++ b/versioned_docs/version-6.2/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#databases.compression.compressallcollectionsdefault) - [Databases.Compression.CompressRevisionsDefault](../../server/configuration/database-configuration.mdx#databases.compression.compressrevisionsdefault) - [Databases.ConcurrentLoadTimeoutInSec](../../server/configuration/database-configuration.mdx#databases.concurrentloadtimeoutinsec) - [Databases.FrequencyToCheckForIdleInSec](../../server/configuration/database-configuration.mdx#databases.frequencytocheckforidleinsec) - [Databases.MaxConcurrentLoads](../../server/configuration/database-configuration.mdx#databases.maxconcurrentloads) + [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) * Server-wide, or database scope: - [Databases.CollectionOperationTimeoutInSec](../../server/configuration/database-configuration.mdx#databases.collectionoperationtimeoutinsec) - [Databases.DeepCleanupThresholdInMin](../../server/configuration/database-configuration.mdx#databases.deepcleanupthresholdinmin) - [Databases.MaxIdleTimeInSec](../../server/configuration/database-configuration.mdx#databases.maxidletimeinsec) - [Databases.OperationTimeoutInSec](../../server/configuration/database-configuration.mdx#databases.operationtimeoutinsec) - [Databases.PulseReadTransactionLimitInMb](../../server/configuration/database-configuration.mdx#databases.pulsereadtransactionlimitinmb) - [Databases.QueryOperationTimeoutInSec](../../server/configuration/database-configuration.mdx#databases.queryoperationtimeoutinsec) - [Databases.QueryTimeoutInSec](../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec) - [Databases.RegularCleanupThresholdInMin](../../server/configuration/database-configuration.mdx#databases.regularcleanupthresholdinmin) + [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.Compression.CompressAllCollectionsDefault 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 a34ded7c80..0c8fbbb5b3 100644 --- a/versioned_docs/version-6.2/server/configuration/etl-configuration.mdx +++ b/versioned_docs/version-6.2/server/configuration/etl-configuration.mdx @@ -16,16 +16,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [ETL.ExtractAndTransformTimeoutInSec](../../server/configuration/etl-configuration.mdx#etl.extractandtransformtimeoutinsec) - * [ETL.MaxBatchSizeInMb](../../server/configuration/etl-configuration.mdx#etl.maxbatchsizeinmb) - * [ETL.MaxFallbackTimeInSec](../../server/configuration/etl-configuration.mdx#etl.maxfallbacktimeinsec) - * [ETL.MaxNumberOfExtractedDocuments](../../server/configuration/etl-configuration.mdx#etl.maxnumberofextracteddocuments) - * [ETL.MaxNumberOfExtractedItems](../../server/configuration/etl-configuration.mdx#etl.maxnumberofextracteditems) - * [ETL.OLAP.MaxNumberOfExtractedDocuments](../../server/configuration/etl-configuration.mdx#etl.olap.maxnumberofextracteddocuments) - * [ETL.Queue.AzureQueueStorage.TimeToLiveInSec](../../server/configuration/etl-configuration.mdx#etl.queue.azurequeuestorage.timetoliveinsec) - * [ETL.Queue.AzureQueueStorage.VisibilityTimeoutInSec](../../server/configuration/etl-configuration.mdx#etl.queue.azurequeuestorage.visibilitytimeoutinsec) - * [ETL.Queue.Kafka.InitTransactionsTimeoutInSec](../../server/configuration/etl-configuration.mdx#etl.queue.kafka.inittransactionstimeoutinsec) - * [ETL.SQL.CommandTimeoutInSec](../../server/configuration/etl-configuration.mdx#etl.sql.commandtimeoutinsec) + * [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.SQL.CommandTimeoutInSec](../../server/configuration/etl-configuration.mdx#etlsqlcommandtimeoutinsec) ## ETL.ExtractAndTransformTimeoutInSec 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 2085ce0028..056dc50221 100644 --- a/versioned_docs/version-6.2/server/configuration/http-configuration.mdx +++ b/versioned_docs/version-6.2/server/configuration/http-configuration.mdx @@ -20,28 +20,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#http.mindataratebytespersec) - * [Http.MinDataRateGracePeriodInSec](../../server/configuration/http-configuration.mdx#http.mindatarategraceperiodinsec) - * [Http.MaxRequestBufferSizeInKb](../../server/configuration/http-configuration.mdx#http.maxrequestbuffersizeinkb) - * [Http.MaxRequestLineSizeInKb](../../server/configuration/http-configuration.mdx#http.maxrequestlinesizeinkb) - * [Http.Http2.KeepAlivePingTimeoutInSec](../../server/configuration/http-configuration.mdx#http.http2.keepalivepingtimeoutinsec) - * [Http.Http2.KeepAlivePingDelayInSec](../../server/configuration/http-configuration.mdx#http.http2.keepalivepingdelayinsec) - * [Http.Http2.MaxStreamsPerConnection](../../server/configuration/http-configuration.mdx#http.http2.maxstreamsperconnection) - * [Http.UseResponseCompression](../../server/configuration/http-configuration.mdx#http.useresponsecompression) - * [Http.AllowResponseCompressionOverHttps](../../server/configuration/http-configuration.mdx#http.allowresponsecompressionoverhttps) - * [Http.GzipResponseCompressionLevel](../../server/configuration/http-configuration.mdx#http.gzipresponsecompressionlevel) - * [Http.DeflateResponseCompressionLevel](../../server/configuration/http-configuration.mdx#http.deflateresponsecompressionlevel) - * [Http.ZstdResponseCompressionLevel](../../server/configuration/http-configuration.mdx#http.zstdresponsecompressionlevel) - * [Http.StaticFilesResponseCompressionLevel](../../server/configuration/http-configuration.mdx#http.staticfilesresponsecompressionlevel) - * [Http.Protocols](../../server/configuration/http-configuration.mdx#http.protocols) - * [Http.AllowSynchronousIO](../../server/configuration/http-configuration.mdx#http.allowsynchronousio) + * [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 * 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#http.mindatarategraceperiodinsec). +* This option must be configured together with [Http.MinDataRateGracePeriod](../../server/configuration/http-configuration.mdx#httpmindatarategraceperiodinsec). - **Type**: `int` - **Default**: `null` - **Scope**: Server-wide only @@ -54,7 +54,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#http.mindataratebytespersec) + This option must be configured together with [Http.MinDataRateBytesPerSec](../../server/configuration/http-configuration.mdx#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 8db6410471..e93607da81 100644 --- a/versioned_docs/version-6.2/server/configuration/indexing-configuration.mdx +++ b/versioned_docs/version-6.2/server/configuration/indexing-configuration.mdx @@ -26,81 +26,81 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this article: * Server-wide scope: - [Indexing.CleanupIntervalInMin](../../server/configuration/indexing-configuration.mdx#indexing.cleanupintervalinmin) - [Indexing.GlobalScratchSpaceLimitInMb](../../server/configuration/indexing-configuration.mdx#indexing.globalscratchspacelimitinmb) - [Indexing.MaxNumberOfConcurrentlyRunningIndexes](../../server/configuration/indexing-configuration.mdx#indexing.maxnumberofconcurrentlyrunningindexes) - [Indexing.MaxTimeToWaitAfterFlushAndSyncWhenExceedingScratchSpaceLimitInSec](../../server/configuration/indexing-configuration.mdx#indexing.maxtimetowaitafterflushandsyncwhenexceedingscratchspacelimitinsec) - [Indexing.NuGetAllowPreReleasePackages](../../server/configuration/indexing-configuration.mdx#indexing.nugetallowprereleasepackages) - [Indexing.NuGetPackageSourceUrl](../../server/configuration/indexing-configuration.mdx#indexing.nugetpackagesourceurl) - [Indexing.NuGetPackagesPath](../../server/configuration/indexing-configuration.mdx#indexing.nugetpackagespath) - [Indexing.QueryClauseCache.ExpirationScanFrequencyInSec](../../server/configuration/indexing-configuration.mdx#indexing.queryclausecache.expirationscanfrequencyinsec) - [Indexing.QueryClauseCache.RepeatedQueriesCount](../../server/configuration/indexing-configuration.mdx#indexing.queryclausecache.repeatedqueriescount) - [Indexing.QueryClauseCache.SizeInMb](../../server/configuration/indexing-configuration.mdx#indexing.queryclausecache.sizeinmb) + [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) * Server-wide, or database scope: - [Indexing.Auto.ArchivedDataProcessingBehavior](../../server/configuration/indexing-configuration.mdx#indexing.auto.archiveddataprocessingbehavior) - [Indexing.Auto.DeploymentMode](../../server/configuration/indexing-configuration.mdx#indexing.auto.deploymentmode) - [Indexing.Auto.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexing.auto.searchenginetype) - [Indexing.Disable](../../server/configuration/indexing-configuration.mdx#indexing.disable) - [Indexing.DisableQueryOptimizerGeneratedIndexes](../../server/configuration/indexing-configuration.mdx#indexing.disablequeryoptimizergeneratedindexes) - [Indexing.ErrorIndexStartupBehavior](../../server/configuration/indexing-configuration.mdx#indexing.errorindexstartupbehavior) - [Indexing.History.NumberOfRevisions](../../server/configuration/indexing-configuration.mdx#indexing.history.numberofrevisions) - [Indexing.IndexStartupBehavior](../../server/configuration/indexing-configuration.mdx#indexing.indexstartupbehavior) - [Indexing.ResetMode](../../server/configuration/indexing-configuration.mdx#indexing.resetmode) - [Indexing.RunInMemory](../../server/configuration/indexing-configuration.mdx#indexing.runinmemory) - [Indexing.SkipDatabaseIdValidationOnIndexOpening](../../server/configuration/indexing-configuration.mdx#indexing.skipdatabaseidvalidationonindexopening) - [Indexing.Static.ArchivedDataProcessingBehavior](../../server/configuration/indexing-configuration.mdx#indexing.static.archiveddataprocessingbehavior) - [Indexing.Static.DeploymentMode](../../server/configuration/indexing-configuration.mdx#indexing.static.deploymentmode) - [Indexing.Static.RequireAdminToDeployJavaScriptIndexes](../../server/configuration/indexing-configuration.mdx#indexing.static.requireadmintodeployjavascriptindexes) - [Indexing.TempPath](../../server/configuration/indexing-configuration.mdx#indexing.temppath) - [Indexing.TimeBeforeDeletionOfSupersededAutoIndexInSec](../../server/configuration/indexing-configuration.mdx#indexing.timebeforedeletionofsupersededautoindexinsec) - [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforedeletingautoindexmarkedasidleinhrs) - [Indexing.TimeToWaitBeforeMarkingAutoIndexAsIdleInMin](../../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforemarkingautoindexasidleinmin) + [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) * Server-wide, or database, or per index: - [Indexing.AllowStringCompilation](../../server/configuration/indexing-configuration.mdx#indexing.allowstringcompilation) - [Indexing.Analyzers.Default](../../server/configuration/indexing-configuration.mdx#indexing.analyzers.default) - [Indexing.Analyzers.Exact.Default](../../server/configuration/indexing-configuration.mdx#indexing.analyzers.exact.default) - [Indexing.Analyzers.Search.Default](../../server/configuration/indexing-configuration.mdx#indexing.analyzers.search.default) - [Indexing.Corax.DocumentsLimitForCompressionDictionaryCreation](../../server/configuration/indexing-configuration.mdx#indexing.corax.documentslimitforcompressiondictionarycreation) - [Indexing.Corax.IncludeDocumentScore](../../server/configuration/indexing-configuration.mdx#indexing.corax.includedocumentscore) - [Indexing.Corax.IncludeSpatialDistance](../../server/configuration/indexing-configuration.mdx#indexing.corax.includespatialdistance) - [Indexing.Corax.MaxAllocationsAtDictionaryTrainingInMb](../../server/configuration/indexing-configuration.mdx#indexing.corax.maxallocationsatdictionarytraininginmb) - [Indexing.Corax.MaxMemoizationSizeInMb](../../server/configuration/indexing-configuration.mdx#indexing.corax.maxmemoizationsizeinmb) - [Indexing.Corax.Static.ComplexFieldIndexingBehavior](../../server/configuration/indexing-configuration.mdx#indexing.corax.static.complexfieldindexingbehavior) - [Indexing.Corax.UnmanagedAllocationsBatchSizeLimitInMb](../../server/configuration/indexing-configuration.mdx#indexing.corax.unmanagedallocationsbatchsizelimitinmb) - [Indexing.Encrypted.TransactionSizeLimitInMb](../../server/configuration/indexing-configuration.mdx#indexing.encrypted.transactionsizelimitinmb) - [Indexing.IndexEmptyEntries](../../server/configuration/indexing-configuration.mdx#indexing.indexemptyentries) - [Indexing.IndexMissingFieldsAsNull](../../server/configuration/indexing-configuration.mdx#indexing.indexmissingfieldsasnull) - [Indexing.Lucene.Analyzers.NGram.MaxGram](../../server/configuration/indexing-configuration.mdx#indexing.lucene.analyzers.ngram.maxgram) - [Indexing.Lucene.Analyzers.NGram.MinGram](../../server/configuration/indexing-configuration.mdx#indexing.lucene.analyzers.ngram.mingram) - [Indexing.Lucene.IndexInputType](../../server/configuration/indexing-configuration.mdx#indexing.lucene.indexinputtype) - [Indexing.Lucene.LargeSegmentSizeToMergeInMb](../../server/configuration/indexing-configuration.mdx#indexing.lucene.largesegmentsizetomergeinmb) - [Indexing.Lucene.MaximumSizePerSegmentInMb](../../server/configuration/indexing-configuration.mdx#indexing.lucene.maximumsizepersegmentinmb) - [Indexing.Lucene.MaxTimeForMergesToKeepRunningInSec](../../server/configuration/indexing-configuration.mdx#indexing.lucene.maxtimeformergestokeeprunninginsec) - [Indexing.Lucene.MergeFactor](../../server/configuration/indexing-configuration.mdx#indexing.lucene.mergefactor) - [Indexing.Lucene.NumberOfLargeSegmentsToMergeInSingleBatch](../../server/configuration/indexing-configuration.mdx#indexing.lucene.numberoflargesegmentstomergeinsinglebatch) - [Indexing.Lucene.ReaderTermsIndexDivisor](../../server/configuration/indexing-configuration.mdx#indexing.lucene.readertermsindexdivisor) - [Indexing.Lucene.UseCompoundFileInMerging](../../server/configuration/indexing-configuration.mdx#indexing.lucene.usecompoundfileinmerging) - [Indexing.ManagedAllocationsBatchSizeLimitInMb](../../server/configuration/indexing-configuration.mdx#indexing.managedallocationsbatchsizelimitinmb) - [Indexing.MapBatchSize](../../server/configuration/indexing-configuration.mdx#indexing.mapbatchsize) - [Indexing.MapTimeoutAfterEtagReachedInMin](../../server/configuration/indexing-configuration.mdx#indexing.maptimeoutafteretagreachedinmin) - [Indexing.MapTimeoutInSec](../../server/configuration/indexing-configuration.mdx#indexing.maptimeoutinsec) - [Indexing.MaxStepsForScript](../../server/configuration/indexing-configuration.mdx#indexing.maxstepsforscript) - [Indexing.MaxTimeForDocumentTransactionToRemainOpenInSec](../../server/configuration/indexing-configuration.mdx#indexing.maxtimefordocumenttransactiontoremainopeninsec) - [Indexing.MaxTimeToWaitAfterFlushAndSyncWhenReplacingSideBySideIndexInSec](../../server/configuration/indexing-configuration.mdx#indexing.maxtimetowaitafterflushandsyncwhenreplacingsidebysideindexinsec) - [Indexing.Metrics.Enabled](../../server/configuration/indexing-configuration.mdx#indexing.metrics.enabled) - [Indexing.MinNumberOfMapAttemptsAfterWhichBatchWillBeCanceledIfRunningLowOnMemory](../../server/configuration/indexing-configuration.mdx#indexing.minnumberofmapattemptsafterwhichbatchwillbecanceledifrunninglowonmemory) - [Indexing.MinimumTotalSizeOfJournalsToRunFlushAndSyncWhenReplacingSideBySideIndexInMb](../../server/configuration/indexing-configuration.mdx#indexing.minimumtotalsizeofjournalstorunflushandsyncwhenreplacingsidebysideindexinmb) - [Indexing.NumberOfConcurrentStoppedBatchesIfRunningLowOnMemory](../../server/configuration/indexing-configuration.mdx#indexing.numberofconcurrentstoppedbatchesifrunninglowonmemory) - [Indexing.NumberOfLargeSegmentsToMergeInSingleBatch](../../server/configuration/indexing-configuration.mdx#indexing.numberoflargesegmentstomergeinsinglebatch) - [Indexing.OrderByScoreAutomaticallyWhenBoostingIsInvolved](../../server/configuration/indexing-configuration.mdx#indexing.orderbyscoreautomaticallywhenboostingisinvolved) - [Indexing.OrderByTicksAutomaticallyWhenDatesAreInvolved](../../server/configuration/indexing-configuration.mdx#indexing.orderbyticksautomaticallywhendatesareinvolved) - [Indexing.QueryClauseCache.Disabled](../../server/configuration/indexing-configuration.mdx#indexing.queryclausecache.disabled) - [Indexing.QueryClauseCache.RepeatedQueriesTimeFrameInSec](../../server/configuration/indexing-configuration.mdx#indexing.queryclausecache.repeatedqueriestimeframeinsec) - [Indexing.ScratchSpaceLimitInMb](../../server/configuration/indexing-configuration.mdx#indexing.scratchspacelimitinmb) - [Indexing.Static.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexing.static.searchenginetype) - [Indexing.Throttling.TimeIntervalInMs](../../server/configuration/indexing-configuration.mdx#indexing.throttling.timeintervalinms) - [Indexing.TimeSinceLastQueryAfterWhichDeepCleanupCanBeExecutedInMin](../../server/configuration/indexing-configuration.mdx#indexing.timesincelastqueryafterwhichdeepcleanupcanbeexecutedinmin) - [Indexing.TransactionSizeLimitInMb](../../server/configuration/indexing-configuration.mdx#indexing.transactionsizelimitinmb) + [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.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.CleanupIntervalInMin @@ -629,7 +629,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#indexing.numberoflargesegmentstomergeinsinglebatch) in a single batch. + We won't merge more than [Indexing.NumberOfLargeSegmentsToMergeInSingleBatch](../../server/configuration/indexing-configuration.mdx#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` @@ -692,7 +692,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#indexing.largesegmentsizetomergeinmb) to merge in a single batch. +* Number of large segments defined by [Indexing.LargeSegmentSizeToMergeInMb](../../server/configuration/indexing-configuration.mdx#indexinglargesegmentsizetomergeinmb) to merge in a single batch. - **Type**: `int` - **Default**: `2` - **Scope**: Server-wide, or per database, or per index @@ -874,7 +874,7 @@ EXPERT ONLY: * Disable the query clause cache for a server, database, or a single index. * The default value is set by the constructor of class `IndexingConfiguration`. - It will be `true` if your core configuration key [Features.Availability](../../server/configuration/core-configuration.mdx#features.availability) is Not set to 'Experimental'. + It will be `true` if your core configuration key [Features.Availability](../../server/configuration/core-configuration.mdx#featuresavailability) is Not set to 'Experimental'. - **Type**: `bool` - **Default**: `DefaultValueSetInConstructor` - **Scope**: Server-wide, or per database, or per index 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 b2384a222c..2178f7f76c 100644 --- a/versioned_docs/version-6.2/server/configuration/license-configuration.mdx +++ b/versioned_docs/version-6.2/server/configuration/license-configuration.mdx @@ -118,7 +118,7 @@ Disable automatic updates of the license from the License Server (api.ravendb.ne 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#license.path) configuration +* Setting the [License.Path](../../server/configuration/license-configuration.mdx#licensepath) configuration * Replacing the _license.json_ file on disk - **Type**: `bool` - **Default**: `false` 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 309846e8ce..596e653626 100644 --- a/versioned_docs/version-6.2/server/configuration/monitoring-configuration.mdx +++ b/versioned_docs/version-6.2/server/configuration/monitoring-configuration.mdx @@ -17,45 +17,45 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: * OpenTelemetry monitoring: - [Monitoring.OpenTelemetry.ConsoleExporter](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.consoleexporter) - [Monitoring.OpenTelemetry.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.enabled) - [Monitoring.OpenTelemetry.Meters.AspNetCore.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.aspnetcore.enabled) - [Monitoring.OpenTelemetry.Meters.Runtime.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.runtime.enabled) - [Monitoring.OpenTelemetry.Meters.Server.CPUCredits.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.cpucredits.enabled) - [Monitoring.OpenTelemetry.Meters.Server.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.enabled) - [Monitoring.OpenTelemetry.Meters.Server.GC.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.gc.enabled) - [Monitoring.OpenTelemetry.Meters.Server.General.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.general.enabled) - [Monitoring.OpenTelemetry.Meters.Server.Requests.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.requests.enabled) - [Monitoring.OpenTelemetry.Meters.Server.Resources.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.resources.enabled) - [Monitoring.OpenTelemetry.Meters.Server.Storage.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.storage.enabled) - [Monitoring.OpenTelemetry.Meters.Server.TotalDatabases.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.totaldatabases.enabled) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.enabled) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Endpoint](../..//server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.endpoint) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.ExportProcessorType](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.exportprocessortype) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Headers](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.headers) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Protocol](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.protocol) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Timeout](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.timeout) - [Monitoring.OpenTelemetry.ServiceInstanceId](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.serviceinstanceid) + [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) * SNMP monitoring - [Monitoring.Snmp.AuthenticationPassword](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationpassword) - [Monitoring.Snmp.AuthenticationPassword.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationpassword.secondary) - [Monitoring.Snmp.AuthenticationProtocol](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationprotocol) - [Monitoring.Snmp.AuthenticationProtocol.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationprotocol.secondary) - [Monitoring.Snmp.AuthenticationUser](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationuser) - [Monitoring.Snmp.AuthenticationUser.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationuser.secondary) - [Monitoring.Snmp.Community](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.community) - [Monitoring.Snmp.DisableTimeWindowChecks](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.disabletimewindowchecks) - [Monitoring.Snmp.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.enabled) - [Monitoring.Snmp.Port](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.port) - [Monitoring.Snmp.PrivacyPassword](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.privacypassword) - [Monitoring.Snmp.PrivacyPassword.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.privacypassword.secondary) - [Monitoring.Snmp.PrivacyProtocol](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.privacyprotocol) - [Monitoring.Snmp.PrivacyProtocol.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.privacyprotocol.secondary) - [Monitoring.Snmp.SupportedVersions](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.supportedversions) + [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) * Other monitoring: - [Monitoring.Cpu.Exec](../../server/configuration/monitoring-configuration.mdx#monitoring.cpu.exec) - [Monitoring.Cpu.Exec.Arguments](../../server/configuration/monitoring-configuration.mdx#monitoring.cpu.exec.arguments) - [Monitoring.Disk.ReadStatsDebounceTimeInMs](../../server/configuration/monitoring-configuration.mdx#monitoring.disk.readstatsdebouncetimeinms) + [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.OpenTelemetry.ConsoleExporter 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 0bfdd7512e..1639b36e61 100644 --- a/versioned_docs/version-6.2/server/configuration/patching-configuration.mdx +++ b/versioned_docs/version-6.2/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#patching.allowstringcompilation) - * [Patching.MaxStepsForScript](../../server/configuration/patching-configuration.mdx#patching.maxstepsforscript) - * [Patching.StrictMode](../../server/configuration/patching-configuration.mdx#patching.strictmode) + * [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 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 7cb37af2d3..ae8237050d 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 @@ -16,15 +16,15 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [PerformanceHints.Documents.HugeDocumentsCollectionSize](../../server/configuration/performance-hints-configuration.mdx#performancehints.documents.hugedocumentscollectionsize) - * [PerformanceHints.Documents.HugeDocumentSizeInMb](../../server/configuration/performance-hints-configuration.mdx#performancehints.documents.hugedocumentsizeinmb) - * [PerformanceHints.Indexing.AlertWhenSourceDocumentIncludedInOutput](../../server/configuration/performance-hints-configuration.mdx#performancehints.indexing.alertwhensourcedocumentincludedinoutput) - * [PerformanceHints.Indexing.MaxDepthOfRecursionInLinqSelect](../../server/configuration/performance-hints-configuration.mdx#performancehints.indexing.maxdepthofrecursioninlinqselect) - * [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../../server/configuration/performance-hints-configuration.mdx#performancehints.indexing.maxindexoutputsperdocument) - * [PerformanceHints.Indexing.MaxNumberOfLoadsPerReference](../../server/configuration/performance-hints-configuration.mdx#performancehints.indexing.maxnumberofloadsperreference) - * [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehints.maxnumberofresults) - * [PerformanceHints.Memory.MinSwapSizeInMb](../../server/configuration/performance-hints-configuration.mdx#performancehints.memory.minswapsizeinmb) - * [PerformanceHints.TooLongRequestThresholdInSec](../../server/configuration/performance-hints-configuration.mdx#performancehints.toolongrequestthresholdinsec) + * [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 diff --git a/versioned_docs/version-6.2/server/configuration/queue-sink-configuration.mdx b/versioned_docs/version-6.2/server/configuration/queue-sink-configuration.mdx index 543abbf9a5..d551ff6821 100644 --- a/versioned_docs/version-6.2/server/configuration/queue-sink-configuration.mdx +++ b/versioned_docs/version-6.2/server/configuration/queue-sink-configuration.mdx @@ -18,7 +18,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; The maximum number of pulled messages consumed in a single batch. - **Default**: `8192` -- **Scope**: [Server-wide](../../server/configuration/configuration-options.mdx#settings.json) +- **Scope**: [Server-wide](../../server/configuration/configuration-options.mdx#settingsjson) or [per database](../../studio/database/settings/database-settings.mdx#view-database-settings) @@ -30,7 +30,7 @@ mode (i.e. suspending the process) after a connection failure. - **Default**: `15*60` - **TimeUnit**: `TimeUnit.Seconds` -- **Scope**: [Server-wide](../../server/configuration/configuration-options.mdx#settings.json) +- **Scope**: [Server-wide](../../server/configuration/configuration-options.mdx#settingsjson) or [per database](../../studio/database/settings/database-settings.mdx#view-database-settings) 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 27a0bca65c..1c0cff71a5 100644 --- a/versioned_docs/version-6.2/server/configuration/security-configuration.mdx +++ b/versioned_docs/version-6.2/server/configuration/security-configuration.mdx @@ -20,50 +20,50 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: * Security.AuditLog: - [Security.AuditLog.Compress](../../server/configuration/security-configuration.mdx#security.auditlog.compress) - [Security.AuditLog.FolderPath](../../server/configuration/security-configuration.mdx#security.auditlog.folderpath) - [Security.AuditLog.RetentionSizeInMb](../../server/configuration/security-configuration.mdx#security.auditlog.retentionsizeinmb) - [Security.AuditLog.RetentionTimeInHours](../../server/configuration/security-configuration.mdx#security.auditlog.retentiontimeinhourssecurity.auditlog.retentiontimeinhrs) + [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.Certificate: - [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#security.certificate.change.exec) - [Security.Certificate.Change.Exec.Arguments](../../server/configuration/security-configuration.mdx#security.certificate.change.exec.arguments) - [Security.Certificate.Exec](../../server/configuration/security-configuration.mdx#security.certificate.exec) - [Security.Certificate.Exec.TimeoutInSec](../../server/configuration/security-configuration.mdx#security.certificate.exec.timeoutinsec) - [Security.Certificate.ExpiringThresholdInDays](../../server/configuration/security-configuration.mdx#security.certificate.expiringthresholdindays) - [Security.Certificate.LetsEncrypt.Email](../../server/configuration/security-configuration.mdx#security.certificate.letsencrypt.email) - [Security.Certificate.Load.Exec](../../server/configuration/security-configuration.mdx#security.certificate.load.exec) - [Security.Certificate.Load.Exec.Arguments](../../server/configuration/security-configuration.mdx#security.certificate.load.exec.arguments) - [Security.Certificate.Password](../../server/configuration/security-configuration.mdx#security.certificate.password) - [Security.Certificate.Path](../../server/configuration/security-configuration.mdx#security.certificate.path) - [Security.Certificate.Renew.Exec](../../server/configuration/security-configuration.mdx#security.certificate.renew.exec) - [Security.Certificate.Renew.Exec.Arguments](../../server/configuration/security-configuration.mdx#security.certificate.renew.exec.arguments) - [Security.Certificate.Validation.Exec](../../server/configuration/security-configuration.mdx#security.certificate.validation.exec) - [Security.Certificate.Validation.Exec.Arguments](../../server/configuration/security-configuration.mdx#security.certificate.validation.exec.arguments) - [Security.Certificate.Validation.Exec.TimeoutInSec](../../server/configuration/security-configuration.mdx#security.certificate.validation.exec.timeoutinsec) - [Security.Certificate.Validation.KeyUsages](../../server/configuration/security-configuration.mdx#security.certificate.validation.keyusages) + [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.Csrf: - [Security.Csrf.AdditionalOriginHeaders](../../server/configuration/security-configuration.mdx#security.csrf.additionaloriginheaders) - [Security.Csrf.Enabled](../../server/configuration/security-configuration.mdx#security.csrf.enabled) - [Security.Csrf.TrustedOrigins](../../server/configuration/security-configuration.mdx#security.csrf.trustedorigins) + [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.MasterKey: - [Security.MasterKey.Exec](../../server/configuration/security-configuration.mdx#security.masterkey.exec) - [Security.MasterKey.Exec.Arguments](../../server/configuration/security-configuration.mdx#security.masterkey.exec.arguments) - [Security.MasterKey.Exec.TimeoutInSec](../../server/configuration/security-configuration.mdx#security.masterkey.exec.timeoutinsec) - [Security.MasterKey.Path](../../server/configuration/security-configuration.mdx#security.masterkey.path) + [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.TwoFactor: - [Security.TwoFactor.DefaultSessionDurationInMin](../../server/configuration/security-configuration.mdx#security.twofactor.defaultsessiondurationinmin) - [Security.TwoFactor.MaxSessionDurationInMin](../../server/configuration/security-configuration.mdx#security.twofactor.maxsessiondurationinmin) + [Security.TwoFactor.DefaultSessionDurationInMin](../../server/configuration/security-configuration.mdx#securitytwofactordefaultsessiondurationinmin) + [Security.TwoFactor.MaxSessionDurationInMin](../../server/configuration/security-configuration.mdx#securitytwofactormaxsessiondurationinmin) * Certificate and issuer validation: - [Security.WellKnownCertificates.Admin](../../server/configuration/security-configuration.mdx#security.wellknowncertificates.admin) - [Security.WellKnownIssuerHashes.Admin](../../server/configuration/security-configuration.mdx#security.wellknownissuerhashes.admin) - [Security.WellKnownIssuers.Admin](../../server/configuration/security-configuration.mdx#security.wellknownissuers.admin) - [Security.WellKnownIssuers.Admin.ValidateCertificateNames](../../server/configuration/security-configuration.mdx#security.wellknownissuers.admin.validatecertificatenames) + [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) * Other: - [Security.DisableHsts](../../server/configuration/security-configuration.mdx#security.disablehsts) - [Security.DisableHttpsRedirection](../../server/configuration/security-configuration.mdx#security.disablehttpsredirection) - [Security.DoNotConsiderMemoryLockFailureAsCatastrophicError](../../server/configuration/security-configuration.mdx#security.donotconsidermemorylockfailureascatastrophicerror) - [Security.TlsCipherSuites](../../server/configuration/security-configuration.mdx#security.tlsciphersuites) - [Security.UnsecuredAccessAllowed](../../server/configuration/security-configuration.mdx#security.unsecuredaccessallowed) + [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.AuditLog.Compress @@ -114,7 +114,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#security.certificate.path) is not defined. +Note: it will only be triggered if [Security.Certificate.Path](../../server/configuration/security-configuration.mdx#securitycertificatepath) is not defined. - **Type**: `string` - **Default**: `null` @@ -124,7 +124,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#security.certificate.change.exec) command or executable. +The command line arguments for the [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#securitycertificatechangeexec) command or executable. - **Type**: `string` - **Default**: `null` @@ -135,9 +135,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#security.certificate.load.exec) -along with [Security.Certificate.Renew.Exec](../../server/configuration/security-configuration.mdx#security.certificate.renew.exec) -and [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#security.certificate.change.exec) instead. +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. @@ -145,9 +145,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#security.certificate.load.exec) - * [Security.Certificate.Renew.Exec](../../server/configuration/security-configuration.mdx#security.certificate.renew.exec) - * [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#security.certificate.change.exec) + * [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) - **Type**: `int` - **Default**: `30` - **Scope**: Server-wide only @@ -180,7 +180,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#security.certificate.path) setting takes precedence over this executable. +* The [Security.Certificate.Path](../../server/configuration/security-configuration.mdx#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` @@ -191,7 +191,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#security.certificate.load.exec) command or executable. +The command line arguments for the [Security.Certificate.Load.Exec](../../server/configuration/security-configuration.mdx#securitycertificateloadexec) command or executable. - **Type**: `string` - **Default**: `null` @@ -229,7 +229,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#security.certificate.change.exec) +* The executable specified in [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#securitycertificatechangeexec) will then be used to persist the certificate across the cluster on all nodes. - **Type**: `string` - **Default**: `null` @@ -239,7 +239,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#security.certificate.renew.exec.arguments) command or executable. +The command line arguments for the [Security.Certificate.Renew.Exec](../../server/configuration/security-configuration.mdx#securitycertificaterenewexecarguments) command or executable. - **Type**: `string` - **Default**: `null` @@ -266,7 +266,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#security.certificate.validation.exec.arguments) command or executable. +The optional user arguments for the [Security.Certificate.Validation.Exec](../../server/configuration/security-configuration.mdx#securitycertificatevalidationexecarguments) command or executable. The arguments must be escaped for the command line. - **Type**: `string` @@ -277,7 +277,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#security.certificate.validation.exec.arguments) executable to exit. +The number of seconds to wait for the [Security.Certificate.Validation.Exec](../../server/configuration/security-configuration.mdx#securitycertificatevalidationexecarguments) executable to exit. - **Type**: `int` - **Default**: `5` @@ -342,7 +342,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#security.masterkey.exec) command or executable. +The command line arguments for the [Security.MasterKey.Exec](../../server/configuration/security-configuration.mdx#securitymasterkeyexec) command or executable. - **Type**: `string` - **Default**: `null` @@ -409,7 +409,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#security.wellknownissuers.admin) instead. +Use [Security.WellKnownIssuers.Admin](../../server/configuration/security-configuration.mdx#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 05f8f5d5af..ddfa8732c1 100644 --- a/versioned_docs/version-6.2/server/configuration/server-configuration.mdx +++ b/versioned_docs/version-6.2/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#server.maxtimefortasktowaitfordatabasetoloadinsec) - * [Server.ProcessAffinityMask](../../server/configuration/server-configuration.mdx#server.processaffinitymask) - * [Server.IndexingAffinityMask](../../server/configuration/server-configuration.mdx#server.indexingaffinitymask) - * [Server.NumberOfUnusedCoresByIndexes](../../server/configuration/server-configuration.mdx#server.numberofunusedcoresbyindexes) - * [Server.CpuCredits.ExhaustionBackupDelayInMin](../../server/configuration/server-configuration.mdx#server.cpucredits.exhaustionbackupdelayinmin) - * [Server.Tcp.Compression.Disable](../../server/configuration/server-configuration.mdx#server.tcp.compression.disable) + * [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 diff --git a/versioned_docs/version-6.2/server/configuration/storage-configuration.mdx b/versioned_docs/version-6.2/server/configuration/storage-configuration.mdx index 556fa7a7f7..6f5830c572 100644 --- a/versioned_docs/version-6.2/server/configuration/storage-configuration.mdx +++ b/versioned_docs/version-6.2/server/configuration/storage-configuration.mdx @@ -31,7 +31,7 @@ The following configuration options allow you configure [the storage engine](../ * The Databases temporary files will be written to `"/Databases/{database-name}"`. * The Configuration temporary files will be written to `"/Databases/{database-name}/Configuration"`. -* To specify a different path for the indexes temporary files go to [Indexing.TempPath](../../server/configuration/indexing-configuration.mdx#indexing.temppath). +* To specify a different path for the indexes temporary files go to [Indexing.TempPath](../../server/configuration/indexing-configuration.mdx#indexingtemppath). * Learn more about RavenDB directory structure [here](../../server/storage/directory-structure.mdx). - **Type**: `string` 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 090f050f0b..7d1e19e83c 100644 --- a/versioned_docs/version-6.2/server/configuration/subscription-configuration.mdx +++ b/versioned_docs/version-6.2/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#subscriptions.archiveddataprocessingbehavior) - * [Subscriptions.MaxNumberOfConcurrentConnections](../../server/configuration/subscription-configuration.mdx#subscriptions.maxnumberofconcurrentconnections) + * [Subscriptions.ArchivedDataProcessingBehavior](../../server/configuration/subscription-configuration.mdx#subscriptionsarchiveddataprocessingbehavior) + * [Subscriptions.MaxNumberOfConcurrentConnections](../../server/configuration/subscription-configuration.mdx#subscriptionsmaxnumberofconcurrentconnections) diff --git a/versioned_docs/version-6.2/server/embedded.mdx b/versioned_docs/version-6.2/server/embedded.mdx index a6a47b2be2..902004d2f5 100644 --- a/versioned_docs/version-6.2/server/embedded.mdx +++ b/versioned_docs/version-6.2/server/embedded.mdx @@ -34,7 +34,7 @@ export const supportedLanguages = ["csharp", "java"]; * [Restarting the Server](../server/embedded.mdx#restarting-the-server) * [ServerProcessExited Event](../server/embedded.mdx#serverprocessexited-event) * [Licensing options](../server/embedded.mdx#licensing-options) - * [.NET FrameworkVersion](../server/embedded.mdx#.net-frameworkversion) + * [.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) 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 edda34e9c8..6d25736646 100644 --- a/versioned_docs/version-6.2/server/kb/javascript-engine.mdx +++ b/versioned_docs/version-6.2/server/kb/javascript-engine.mdx @@ -47,9 +47,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * **Execution limitations**: * RavenDB limits the amount of statements that can be performed for each document processing. - The default value is **10,000** and it can be set using the [Patching.MaxStepsForScript](../../server/configuration/patching-configuration.mdx#patching.maxstepsforscript) configuration. + The default value is **10,000** and it can be set using the [Patching.MaxStepsForScript](../../server/configuration/patching-configuration.mdx#patchingmaxstepsforscript) configuration. * RavenDB limits the amount of cached Jint engines. - The default value is **2,048** and it can be set using the [Patching.MaxNumberOfCachedScripts](../../server/configuration/patching-configuration.mdx#patching.maxstepsforscript) configuration. + The default value is **2,048** and it can be set using the [Patching.MaxNumberOfCachedScripts](../../server/configuration/patching-configuration.mdx#patchingmaxstepsforscript) configuration. * Recursive calls within scripts are limited to a depth of **64**, a constant value that cannot be modified. 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 1458379bc1..84aa710c81 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 @@ -196,16 +196,16 @@ For each ETL type, the target must be: Documents are extracted and transformed by the ETL process in a batch manner. The number of documents processed depends on the following configuration limits: -* [`ETL.ExtractAndTransformTimeoutInSec`](../../../server/configuration/etl-configuration.mdx#etl.extractandtransformtimeoutinsec) (default: 30 sec) +* [`ETL.ExtractAndTransformTimeoutInSec`](../../../server/configuration/etl-configuration.mdx#etlextractandtransformtimeoutinsec) (default: 30 sec) Time-frame for the extraction and transformation stages (in seconds), after which the loading stage will start. -* [`ETL.MaxNumberOfExtractedDocuments`](../../../server/configuration/etl-configuration.mdx#etl.maxnumberofextracteddocuments) (default: 8192) +* [`ETL.MaxNumberOfExtractedDocuments`](../../../server/configuration/etl-configuration.mdx#etlmaxnumberofextracteddocuments) (default: 8192) Maximum number of extracted documents in an ETL batch. -* [`ETL.MaxNumberOfExtractedItems`](../../../server/configuration/etl-configuration.mdx#etl.maxnumberofextracteditems) (default: 8192) +* [`ETL.MaxNumberOfExtractedItems`](../../../server/configuration/etl-configuration.mdx#etlmaxnumberofextracteditems) (default: 8192) Maximum number of extracted items (documents, counters) in an ETL batch. -* [`ETL.MaxBatchSizeInMb`](../../../server/configuration/etl-configuration.mdx#etl.maxbatchsizeinmb) (default: 64 MB) +* [`ETL.MaxBatchSizeInMb`](../../../server/configuration/etl-configuration.mdx#etlmaxbatchsizeinmb) (default: 64 MB) Maximum size of an ETL batch in MB. @@ -257,7 +257,7 @@ You will be notified if any of the following events happen: If the ETL cannot proceed the load stage (e.g. it can't connect to the destination) then it enters the fallback mode. The fallback mode means suspending the process and retrying it periodically. The fallback time starts from 5 seconds and it's doubled on every consecutive error according to the time passed since the last error, -but it never crosses [`ETL.MaxFallbackTimeInSec`](../../../server/configuration/etl-configuration.mdx#etl.maxfallbacktimeinsec) configuration (default: 900 sec). +but it never crosses [`ETL.MaxFallbackTimeInSec`](../../../server/configuration/etl-configuration.mdx#etlmaxfallbacktimeinsec) configuration (default: 900 sec). Once the process is in the fallback mode, then the _Reconnect_ state is shown in the Studio. 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 0902fb1757..33d0b31b61 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 @@ -109,7 +109,7 @@ This is the list of different settings objects that the `OlapConnectionString` o | Property | Type | Description | | - | - | - | -| `FolderPath` | `string` | Path to local folder. If this property is not set, the data is saved to the location specified in [the setting `Storage.TempPath`](../../../server/configuration/storage-configuration.mdx#storage.temppath). If _that_ setting has no value, the data is instead saved to the location specified in [the setting `CoreConfiguration.DataDirectory`](../../../server/configuration/core-configuration.mdx#datadir). | +| `FolderPath` | `string` | Path to local folder. If this property is not set, the data is saved to the location specified in [the setting `Storage.TempPath`](../../../server/configuration/storage-configuration.mdx#storagetemppath). If _that_ setting has no value, the data is instead saved to the location specified in [the setting `CoreConfiguration.DataDirectory`](../../../server/configuration/core-configuration.mdx#datadir). | #### `FtpSettings` 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 fdae2cfb71..5eb953e060 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 @@ -30,7 +30,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * [Azure Functions](https://learn.microsoft.com/en-us/azure/azure-functions/functions-overview?pivots=programming-language-csharp) can be triggered to consume and process messages that are sent to Azure queues, enabling powerful and flexible workflows. - The message visibility period and life span in the Queue can be customized through these [ETL configuration options](../../../../server/configuration/etl-configuration.mdx#etl.queue.azurequeuestorage.timetoliveinsec). + The message visibility period and life span in the Queue can be customized through these [ETL configuration options](../../../../server/configuration/etl-configuration.mdx#etlqueueazurequeuestoragetimetoliveinsec). * Read more about Azure Queue Storage in the platform's [official documentation](https://learn.microsoft.com/en-us/azure/storage/queues/storage-queues-introduction). * This article focuses on how to create an Azure Queue Storage ETL task using the Client API. 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 7c20ea955a..12991c890e 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 @@ -311,7 +311,7 @@ The SQL ETL task does not support sending [Counters](../../../document-extension * **Command timeout** Number of seconds after which SQL command will timeout. - It overrides the value defined in the [ETL.SQL.CommandTimeoutInSec](../../../server/configuration/etl-configuration.mdx#etl.sql.commandtimeoutinsec) configuration key. + It overrides the value defined in the [ETL.SQL.CommandTimeoutInSec](../../../server/configuration/etl-configuration.mdx#etlsqlcommandtimeoutinsec) configuration key. Default: `null` (use provider default). * **Parameterized deletes** Control whether DELETE statements generated during the ETL process use parameterized SQL queries, 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 fe42113ee4..9262645a22 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 @@ -303,9 +303,9 @@ AddQueueSinkOperationResult addQueueSinkOperationResult = Use these configuration options to gain more control over queue sink tasks. -* [QueueSink.MaxBatchSize](../../../server/configuration/queue-sink-configuration.mdx#queuesink.maxbatchsize) +* [QueueSink.MaxBatchSize](../../../server/configuration/queue-sink-configuration.mdx#queuesinkmaxbatchsize) The maximum number of pulled messages consumed in a single batch. -* [QueueSink.MaxFallbackTimeInSec](../../../server/configuration/queue-sink-configuration.mdx#queuesink.maxfallbacktimeinsec) +* [QueueSink.MaxFallbackTimeInSec](../../../server/configuration/queue-sink-configuration.mdx#queuesinkmaxfallbacktimeinsec) The maximum number of seconds the Queue Sink process will be in a fallback mode (i.e. suspending the process) after a connection failure. 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 6e12efa79e..b4e2fb6a6a 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 @@ -290,9 +290,9 @@ AddQueueSinkOperationResult addQueueSinkOperationResult = Use these configuration options to gain more control over queue sink tasks. -* [QueueSink.MaxBatchSize](../../../server/configuration/queue-sink-configuration.mdx#queuesink.maxbatchsize) +* [QueueSink.MaxBatchSize](../../../server/configuration/queue-sink-configuration.mdx#queuesinkmaxbatchsize) The maximum number of pulled messages consumed in a single batch. -* [QueueSink.MaxFallbackTimeInSec](../../../server/configuration/queue-sink-configuration.mdx#queuesink.maxfallbacktimeinsec) +* [QueueSink.MaxFallbackTimeInSec](../../../server/configuration/queue-sink-configuration.mdx#queuesinkmaxfallbacktimeinsec) The maximum number of seconds the Queue Sink process will be in a fallback mode (i.e. suspending the process) after a connection failure. 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 303d30d102..30af4c6805 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 @@ -32,13 +32,13 @@ import LanguageContent from "@site/src/components/LanguageContent"; ## Enabling the audit log * **To enable writing to the audit log**, set the following configuration key: - * [Security.AuditLog.FolderPath](../../../server/configuration/security-configuration.mdx#security.auditlog.folderpath) - set the path to a folder where RavenDB will store the audit logs. + * [Security.AuditLog.FolderPath](../../../server/configuration/security-configuration.mdx#securityauditlogfolderpath) - set the path to a folder where RavenDB will store the audit logs. * In addition, the following configurations are available: - * [Security.AuditLog.RetentionTimeInHours](../../../server/configuration/security-configuration.mdx#security.auditlog.retentiontimeinhourssecurity.auditlog.retentiontimeinhrs) - set the number of hours audit logs are kept before they are deleted. - * [Security.AuditLog.RetentionSizeInMb](../../../server/configuration/security-configuration.mdx#security.auditlog.retentionsizeinmb) - The maximum total size of audit log files, after which older files will be deleted. - * [Security.AuditLog.Compress](../../../server/configuration/security-configuration.mdx#security.auditlog.compress) - determine whether to compress the audit log files. - * [Logs.MaxFileSizeInMb](../../../server/configuration/logs-configuration.mdx#logs.maxfilesizeinmb) - a new log file is created when this limit is reached (or daily). + * [Security.AuditLog.RetentionTimeInHours](../../../server/configuration/security-configuration.mdx#securityauditlogretentiontimeinhourssecurityauditlogretentiontimeinhrs) - set the number of hours audit logs are kept before they are deleted. + * [Security.AuditLog.RetentionSizeInMb](../../../server/configuration/security-configuration.mdx#securityauditlogretentionsizeinmb) - The maximum total size of audit log files, after which older files will be deleted. + * [Security.AuditLog.Compress](../../../server/configuration/security-configuration.mdx#securityauditlogcompress) - determine whether to compress the audit log files. + * [Logs.MaxFileSizeInMb](../../../server/configuration/logs-configuration.mdx#logsmaxfilesizeinmb) - a new log file is created when this limit is reached (or daily). * Learn how to set configuration keys in this [configuration overview](../../../server/configuration/configuration-options.mdx). 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 fbac3d6b4d..6b1ac65ded 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 @@ -38,7 +38,7 @@ authentication in a much easier and faster way with automatic certificate renewa ## Prerequisites To enable authentication, either `Security.Certificate.Path` or `Security.Certificate.Load.Exec` must be set in [settings.json](../../configuration/configuration-options.mdx#json). - Please note that `Security.Certificate.Load.Exec` has replaced the old `Security.Certificate.Exec` as of 4.2 - [see FAQ](../../../server/security/common-errors-and-faq.mdx#automatic-cluster-certificate-renewal-following-migration-to-4.2). + Please note that `Security.Certificate.Load.Exec` has replaced the old `Security.Certificate.Exec` as of 4.2 - [see FAQ](../../../server/security/common-errors-and-faq.mdx#automatic-cluster-certificate-renewal-following-migration-to-42). #### 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). @@ -81,7 +81,7 @@ and include a basic (`Key Usage`) field and an enhanced (`Enhanced Key Usage`) f #### Certificate Location -A [settings.json](../../configuration/configuration-options.mdx#settings.json) file must reside in each node's `Server` folder +A [settings.json](../../configuration/configuration-options.mdx#settingsjson) file must reside in each node's `Server` folder and define the server and certificate settings. The server will retrieve this file and use its settings on startup. Read more about RavenDB configuration options [here](../../configuration/configuration-options.mdx). 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 b0bec6ec14..1e12df432e 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 @@ -112,7 +112,7 @@ A `User` certificate with a `Read/Write` access level can perform all operations * [JavaScript static indexes](../../../indexes/javascript-indexes.mdx) are permitted by default with Read/Write User certificates. To configure a server or database so that only Admin certificates will be able to deploy JavaScript static indexes, - set [Indexing.Static.RequireAdminToDeployJavaScriptIndexes](../../../server/configuration/indexing-configuration.mdx#indexing.static.requireadmintodeployjavascriptindexes) + set [Indexing.Static.RequireAdminToDeployJavaScriptIndexes](../../../server/configuration/indexing-configuration.mdx#indexingstaticrequireadmintodeployjavascriptindexes) to `true`. ### `Read Only` 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 e5ad83daf7..b8159f27b5 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 @@ -233,7 +233,7 @@ Learn how to handle this issue [here](../../server/security/authentication/solve * [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-4.2) +* [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 You cannot access Studio using Edge, though during @@ -453,7 +453,7 @@ In PowerShell it can be solved like this: An admin client certificate can be generated through the [RavenDB CLI](../../server/administration/cli#generateclientcert If RavenDB runs as a console application, the CLI is just there. When running as a service, please use the `rvn admin-channel`. Use either the [generateClientCert](../../server/administration/cli.mdx#generateclientcert) command, or (if you already have a certificate) the [trustClientCert](../../server/administration/cli.mdx#trustclientcert) command. -Another way to gain access for an existing certificate is to add the [Security.WellKnownCertificates.Admin](../../server/configuration/security-configuration.mdx#security.wellknowncertificates.admin) configuration to `settings.json` with your existing certificate's thumbprint. +Another way to gain access for an existing certificate is to add the [Security.WellKnownCertificates.Admin](../../server/configuration/security-configuration.mdx#securitywellknowncertificatesadmin) configuration to `settings.json` with your existing certificate's thumbprint. In this case, a server restart is required. ### Certificate is not recognized when setting up on Azure App Services @@ -502,7 +502,7 @@ Treating this as a catastrophic error and aborting the current operation. When encryption is turned on, RavenDB locks memory in order to avoid leaking secrets to disk. Read more [here](../../server/security/encryption/encryption-at-rest.mdx#locking-memory). By default, RavenDB treats this error as catastrophic and will not continue the operation. -You can change this behavior but it's not recommended and should be done only after a proper security analysis is performed, see the [Security Configuration Section](../../server/configuration/security-configuration.mdx#security.donotconsidermemorylockfailureascatastrophicerror). +You can change this behavior but it's not recommended and should be done only after a proper security analysis is performed, see the [Security Configuration Section](../../server/configuration/security-configuration.mdx#securitydonotconsidermemorylockfailureascatastrophicerror). If such a catastrophic error occurs in **Windows**, RavenDB will try to recover automatically by increasing the size of the minimum working set and retrying the operation. In **Linux**, it is the admin's responsibility to configure higher limits manually using: diff --git a/versioned_docs/version-6.2/server/security/encryption/database-encryption.mdx b/versioned_docs/version-6.2/server/security/encryption/database-encryption.mdx index 2c990ee7d0..d2a8e4789c 100644 --- a/versioned_docs/version-6.2/server/security/encryption/database-encryption.mdx +++ b/versioned_docs/version-6.2/server/security/encryption/database-encryption.mdx @@ -150,7 +150,7 @@ Database encryption must be enabled when creating the database. If you wish to u Indexing is most efficient when it is performed in the largest transactions possible. However, using encryption is very memory intensive, and if memory runs out before the transaction completes, the entire transaction will fail. To avoid this, you can limit the size of indexing batches in encrypted -databases using [Indexing.Encrypted.TransactionSizeLimitInMb](../../../server/configuration/indexing-configuration.mdx#indexing.encrypted.transactionsizelimitinmb). +databases using [Indexing.Encrypted.TransactionSizeLimitInMb](../../../server/configuration/indexing-configuration.mdx#indexingencryptedtransactionsizelimitinmb). 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 45a4a1dedf..5d2a6d34ac 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 @@ -45,7 +45,7 @@ request, and when the transaction is finished, modified pages are encrypted and Indexing is most efficient when it is performed in the largest transactions possible. However, using encryption can be very memory intensive, and if memory runs out before the transaction completes, the entire transaction will fail. To avoid this, you can limit the size of indexing batches in encrypted -databases using [Indexing.Encrypted.TransactionSizeLimitInMb](../../../server/configuration/indexing-configuration.mdx#indexing.encrypted.transactionsizelimitinmb). +databases using [Indexing.Encrypted.TransactionSizeLimitInMb](../../../server/configuration/indexing-configuration.mdx#indexingencryptedtransactionsizelimitinmb). The default limit is 64 MB. @@ -64,7 +64,7 @@ However, the memory-mapped files used for **special temporary buffers** (compres We lock the memory regions used by these buffers in order to avoid leaking secrets to disk. This means that if we run out of memory, the OS is not allowed to page these buffers to disk. The downside to this approach is that if we run out of physical RAM RavenDB won't be able to lock memory and will abort the current operation. -You can change this behavior but it's not recommended and should be done only after a proper security analysis is performed, see the [Security Configuration Section](../../../server/configuration/security-configuration.mdx#security.donotconsidermemorylockfailureascatastrophicerror). +You can change this behavior but it's not recommended and should be done only after a proper security analysis is performed, see the [Security Configuration Section](../../../server/configuration/security-configuration.mdx#securitydonotconsidermemorylockfailureascatastrophicerror). If such a catastrophic error occurs in **Windows**, RavenDB will try to recover automatically by increasing the size of the minimum working set and retrying the operation. RavenDB's ability to do this may be limited by the ['increase a process working set' policy setting](https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/increase-a-process-working-set), 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 c2cfb45491..8ae84c0444 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 @@ -46,26 +46,26 @@ import LanguageContent from "@site/src/components/LanguageContent"; * __System temporary files__ By default, temporary files containing cluster data and server-wide data are written to the `Temp` folder under the System directory. - Customize the path for these files by setting the [Storage.TempPath](../../server/configuration/storage-configuration.mdx#storage.temppath) configuration option. + Customize the path for these files by setting the [Storage.TempPath](../../server/configuration/storage-configuration.mdx#storagetemppath) configuration option. The temporary files will be written to the combined path `"/System"`. * __Databases temporary files__ By default, all databases' temporary files are written to the `Temp` folder under each Database directory. - Customize the path for these files by setting the [Storage.TempPath](../../server/configuration/storage-configuration.mdx#storage.temppath) configuration option. + Customize the path for these files by setting the [Storage.TempPath](../../server/configuration/storage-configuration.mdx#storagetemppath) configuration option. The temporary files will be written to `"/Databases/{database-name}"`. * __Configuration temporary files__ By default, the configuration temporary files are written to the `Temp` folder under the Configuration directory per database. - Customize the path for these files by setting the [Storage.TempPath](../../server/configuration/storage-configuration.mdx#storage.temppath) configuration option. + Customize the path for these files by setting the [Storage.TempPath](../../server/configuration/storage-configuration.mdx#storagetemppath) configuration option. The temporary files will be written to `"/Databases/{database-name}/Configuration"`. * __Indexes temporary files__ By default, all indexes' temporary files are written to the `Temp` folder under each Index directory. - Customize the path for these files by setting the [Indexing.TempPath](../../server/configuration/indexing-configuration.mdx#indexing.temppath) configuration option. + Customize the path for these files by setting the [Indexing.TempPath](../../server/configuration/indexing-configuration.mdx#indexingtemppath) configuration option. * __Backup temporary files__ By default, backup temporary files are written under the `Database` directory or under `Storage.TempPath` if defined. - Customize the path for these files by setting the [Backup.TempPath](../../server/configuration/backup-configuration.mdx#backup.temppath) configuration option. + Customize the path for these files by setting the [Backup.TempPath](../../server/configuration/backup-configuration.mdx#backuptemppath) configuration option. @@ -137,7 +137,7 @@ ln -s /mnt/FastDrive/Databases/Northwind/Indexes ~/RavenDB/Server/RavenData/Data ## Automate storage definitions -* To help automate the process, we have added the [on directory initialize](../../server/configuration/storage-configuration.mdx#storage.ondirectoryinitialize.exec) configuration option. +* To help automate the process, we have added the [on directory initialize](../../server/configuration/storage-configuration.mdx#storageondirectoryinitializeexec) configuration option. Whenever RavenDB __creates a directory__, it will invoke the process that is defined within that configuration. * The process is called just before the directory is created. @@ -145,7 +145,7 @@ ln -s /mnt/FastDrive/Databases/Northwind/Indexes ~/RavenDB/Server/RavenData/Data * RavenDB will invoke the process with the following params: * Params passed by the user: - * User arguments - optional params, set in the [optional user arguments](../../server/configuration/storage-configuration.mdx#storage.ondirectoryinitialize.exec.arguments) configuration option + * User arguments - optional params, set in the [optional user arguments](../../server/configuration/storage-configuration.mdx#storageondirectoryinitializeexecarguments) configuration option * Params passed by RavenDB: * The environment type (System, Database, Index, Configuration, Compaction) diff --git a/versioned_docs/version-6.2/server/storage/documents-compression.mdx b/versioned_docs/version-6.2/server/storage/documents-compression.mdx index 30f1bb2b03..410bb0cb14 100644 --- a/versioned_docs/version-6.2/server/storage/documents-compression.mdx +++ b/versioned_docs/version-6.2/server/storage/documents-compression.mdx @@ -25,7 +25,7 @@ export const supportedLanguages = ["csharp", "nodejs"]; to achieve more efficient data storage with constantly improving compression ratios. * Documents compression can be set for all collections, selected collections, and revisions. - Default compression settings are [configurable](../../server/configuration/database-configuration.mdx#databases.compression.compressallcollectionsdefault). + Default compression settings are [configurable](../../server/configuration/database-configuration.mdx#databasescompressioncompressallcollectionsdefault). * When turned on, compression will be applied to: * **New documents**: @@ -194,7 +194,7 @@ await store.Maintenance.Server.SendAsync(new UpdateDatabaseOperation(dbrecord, d to achieve more efficient data storage with constantly improving compression ratios. * Documents compression can be set for all collections, selected collections, and revisions. - Default compression settings are [configurable](../../server/configuration/database-configuration.mdx#databases.compression.compressallcollectionsdefault). + Default compression settings are [configurable](../../server/configuration/database-configuration.mdx#databasescompressioncompressallcollectionsdefault). * When turned on, compression will be applied to: * **New documents**: diff --git a/versioned_docs/version-6.2/server/tcp-compression.mdx b/versioned_docs/version-6.2/server/tcp-compression.mdx index 0876ca922b..06e7493040 100644 --- a/versioned_docs/version-6.2/server/tcp-compression.mdx +++ b/versioned_docs/version-6.2/server/tcp-compression.mdx @@ -88,7 +88,7 @@ No additional configuration is needed to enable this feature. * TCP Compression can also be disabled server-wide, using the - server [Server.Tcp.Compression.Disable](../server/configuration/server-configuration.mdx#server.tcp.compression.disable) configuration. + server [Server.Tcp.Compression.Disable](../server/configuration/server-configuration.mdx#servertcpcompressiondisable) configuration. Learn how to change database settings using Studio [here](../studio/database/settings/database-settings.mdx). 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 971dc350d4..4aa780bffe 100644 --- a/versioned_docs/version-6.2/server/troubleshooting/collect-info.mdx +++ b/versioned_docs/version-6.2/server/troubleshooting/collect-info.mdx @@ -131,9 +131,9 @@ then enable the following logs (if not enabled yet) before downloading existing * To maintain a specific setting after a server restart, set the following configuration keys in your [default configuration](../../server/configuration/configuration-options.mdx): - * Server logs - set [Logs.Mode](../../server/configuration/logs-configuration.mdx#logs.mode) - * Microsoft logs - set [Logs.Microsoft.Disable](../../server/configuration/logs-configuration.mdx#logs.microsoft.disable) - * Traffic Watch log - set [TrafficWatch.Mode](../../server/configuration/traffic-watch-configuration.mdx#trafficwatch.mode) + * Server logs - set [Logs.Mode](../../server/configuration/logs-configuration.mdx#logsmode) + * Microsoft logs - set [Logs.Microsoft.Disable](../../server/configuration/logs-configuration.mdx#logsmicrosoftdisable) + * Traffic Watch log - set [TrafficWatch.Mode](../../server/configuration/traffic-watch-configuration.mdx#trafficwatchmode) @@ -166,11 +166,11 @@ __If the Studio is unavailable__, or if the logs downloaded via the Studio appea then copy the log files directly from the disk to another location to ensure that you keep them, avoiding potential loss due to the retention configuration. -* The location of the log files is determined by the [Logs.Path](../../server/configuration/logs-configuration.mdx#logs.path) configuration. +* The location of the log files is determined by the [Logs.Path](../../server/configuration/logs-configuration.mdx#logspath) configuration. * Logs deletion time is controlled by the following configurations: - * [Retention time in hours](../../server/configuration/logs-configuration.mdx#logs.retentiontimeinhrs) - * [Retention time in megabytes](../../server/configuration/logs-configuration.mdx#logs.retentionsizeinmb) + * [Retention time in hours](../../server/configuration/logs-configuration.mdx#logsretentiontimeinhrs) + * [Retention time in megabytes](../../server/configuration/logs-configuration.mdx#logsretentionsizeinmb) diff --git a/versioned_docs/version-6.2/sharding/overview.mdx b/versioned_docs/version-6.2/sharding/overview.mdx index 9a4fcadea5..805c7ece7d 100644 --- a/versioned_docs/version-6.2/sharding/overview.mdx +++ b/versioned_docs/version-6.2/sharding/overview.mdx @@ -234,7 +234,7 @@ Using a node's local IP address for inter-cluster communications can speed up th Using this method can be particularly helpful in a sharded cluster, where each client request is handled by an orchestrator that may need to communicate with all other shards to process the request and its results. -Use [this configuration option](../server/configuration/core-configuration.mdx#serverurl.cluster) to expose a node's local IP address to other nodes. +Use [this configuration option](../server/configuration/core-configuration.mdx#serverurlcluster) to expose a node's local IP address to other nodes. diff --git a/versioned_docs/version-6.2/start/containers/requirements/security.mdx b/versioned_docs/version-6.2/start/containers/requirements/security.mdx index 7e2f8e8a5b..6521d1a3ad 100644 --- a/versioned_docs/version-6.2/start/containers/requirements/security.mdx +++ b/versioned_docs/version-6.2/start/containers/requirements/security.mdx @@ -40,11 +40,11 @@ After getting your cert, start tuning the server to leverage it for security. RavenDB needs to get its server certificate. You can configure its retrieval from one of these origins: - Path - A .pfx certificate stored under a path reachable for a container. - **Security.Certificate.Path** configuration option value defines the path. [Security Configuration - Security.Certificate.Path](../../../server/configuration/security-configuration.mdx#security.certificate.path) + **Security.Certificate.Path** configuration option value defines the path. [Security Configuration - Security.Certificate.Path](../../../server/configuration/security-configuration.mdx#securitycertificatepath) - Script - A script that returns your certificate by any means. You can obtain it from container environmental variables, secured vault, secret, etc. - **Security.Certificate.Load.Exec** configuration option value defines the script path. [Security Configuration - Security.Certificate.Load.Exec](../../../server/configuration/security-configuration.mdx#security.certificate.load.exec) + **Security.Certificate.Load.Exec** configuration option value defines the script path. [Security Configuration - Security.Certificate.Load.Exec](../../../server/configuration/security-configuration.mdx#securitycertificateloadexec) These configuration options can be passed to RavenDB by settings.json, environmental variables, or command line arguments. See more here: [Configuration Options](../../../server/configuration/configuration-options.mdx) @@ -60,14 +60,14 @@ To enable it, set `Setup.Mode` configuration option to `LetsEncrypt`. Be aware that this automation will work **only when using Setup Wizard to obtain the LetsEncrypt certificate**, as RavenDB doesn't control your domain nor can access your backend used in the certificate load script. To learn more about this, visit this site: [RavenDB Lets Encrypt Certificates Docs](../../../server/security/authentication/lets-encrypt-certificates.mdx) -You can learn about different `Raven.SetupMode` values here: [Core Configuration - Setup.Mode](../../../server/configuration/core-configuration.mdx#setup.mode) +You can learn about different `Raven.SetupMode` values here: [Core Configuration - Setup.Mode](../../../server/configuration/core-configuration.mdx#setupmode) Also, you need to provide us with an email that you will use for the Let's Encrypt matter. Use `Security.Certificate.LetsEncrypt.Email`. #### Manual To configure manual certificate replacement and updates, write scripts to supply RavenDB configuration: -- [Security.Certificate.Renew.Exec](../../../server/configuration/security-configuration.mdx#security.certificate.renew.exec) -- [Security.Certificate.Change.Exec](../../../server/configuration/security-configuration.mdx#security.certificate.change.exec) +- [Security.Certificate.Renew.Exec](../../../server/configuration/security-configuration.mdx#securitycertificaterenewexec) +- [Security.Certificate.Change.Exec](../../../server/configuration/security-configuration.mdx#securitycertificatechangeexec) It will allow RavenDB to execute your routines, which should: diff --git a/versioned_docs/version-6.2/start/getting-started.mdx b/versioned_docs/version-6.2/start/getting-started.mdx index d53700322d..80754e0173 100644 --- a/versioned_docs/version-6.2/start/getting-started.mdx +++ b/versioned_docs/version-6.2/start/getting-started.mdx @@ -146,7 +146,7 @@ appearing: ### Configuration -The RavenDB server uses a [settings.json](../server/configuration/configuration-options.mdx#settings.json) file in each node `Server` folder to store the server-wide configuration options. +The RavenDB server uses a [settings.json](../server/configuration/configuration-options.mdx#settingsjson) file in each node `Server` folder to store the server-wide configuration options. When starting a server, RavenDB will look for the `settings.json` file in the node `Server` folder, so it must be located there. The [Setup Wizard](../start/installation/setup-wizard.mdx) places it correctly automatically. @@ -190,9 +190,9 @@ For a list of IPs and ports already in use, run `netstat -a` in the command line RavenDB requires write permissions to the following locations: -- The folder where RavenDB server is running (to update [settings.json](../server/configuration/configuration-options.mdx#settings.json) by the [Setup Wizard](../start/installation/setup-wizard.mdx)) +- The folder where RavenDB server is running (to update [settings.json](../server/configuration/configuration-options.mdx#settingsjson) by the [Setup Wizard](../start/installation/setup-wizard.mdx)) - The data folder ([`DataDir`](../server/configuration/core-configuration.mdx#datadir) setting) -- The logs folder ([`Logs.Path`](../server/configuration/logs-configuration.mdx#logs.path) setting) +- The logs folder ([`Logs.Path`](../server/configuration/logs-configuration.mdx#logspath) setting) If you intend to run as a service, the write permissions should be granted to the user running the service (e.g. "Local Service"). 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 3b858f8919..8942c27bcd 100644 --- a/versioned_docs/version-6.2/start/installation/deployment-considerations.mdx +++ b/versioned_docs/version-6.2/start/installation/deployment-considerations.mdx @@ -100,7 +100,7 @@ permissions to the RavenDB directory and to the specified data directory. You ca On Linux, you'll typically run RavenDB as a daemon. The `install-daemon.sh` can handle the daemon registration for you (Ubuntu only). -In either case, you can configure RavenDB using the [settings.json](../../server/configuration/configuration-options.mdx#settings.json) file. The most important configurations are the data directory and the +In either case, you can configure RavenDB using the [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) file. The most important configurations are the data directory and the IPs and ports RavenDB will listen to. It is recommended that you'll pick the fastest drives for RavenDB's data directory, while the binaries for RavenDB can reside anywhere in the system. diff --git a/versioned_docs/version-6.2/start/installation/manual.mdx b/versioned_docs/version-6.2/start/installation/manual.mdx index bbb358cfbb..ba3894b45a 100644 --- a/versioned_docs/version-6.2/start/installation/manual.mdx +++ b/versioned_docs/version-6.2/start/installation/manual.mdx @@ -42,7 +42,7 @@ We recommend using multiple machines to improve [cluster availability via failov By default, when a server is started using `run.ps1` (or `run.sh` in Linux) script. It will open a browser with a [Setup Wizard](../../start/installation/setup-wizard.mdx) which will guide you through the server configuration process. -The setup is started because the default configuration file [settings.json](../../server/configuration/configuration-options.mdx#settings.json) (found in the downloaded RavenDB Server package inside the **Server** folder) comes configured like this: +The setup is started because the default configuration file [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) (found in the downloaded RavenDB Server package inside the **Server** folder) comes configured like this: @@ -93,5 +93,5 @@ Read the [Manual Certificate Configuration](../../server/security/authentication ## Configuration -Read the [Configuration Section](../../server/configuration/configuration-options.mdx) to learn more about using [settings.json](../../server/configuration/configuration-options.mdx#settings.json) and see a list of configuration options. +Read the [Configuration Section](../../server/configuration/configuration-options.mdx) to learn more about using [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) and see a list of configuration options. diff --git a/versioned_docs/version-6.2/start/installation/setup-examples/aws-linux-vm.mdx b/versioned_docs/version-6.2/start/installation/setup-examples/aws-linux-vm.mdx index 1f9dbc372b..6faa8e41a9 100644 --- a/versioned_docs/version-6.2/start/installation/setup-examples/aws-linux-vm.mdx +++ b/versioned_docs/version-6.2/start/installation/setup-examples/aws-linux-vm.mdx @@ -132,7 +132,7 @@ Locate the VM's private and public IP addresses in the AWS EC2 Management Consol You have a few choices on how to run the RavenDB server. We will use the [Setup Wizard](../../../start/installation/setup-wizard.mdx), but you can also configure things [manually](../../../start/installation/manual.mdx). -Let's edit the [settings.json](../../../server/configuration/configuration-options.mdx#settings.json) file so that we can perform the setup remotely using the browser. +Let's edit the [settings.json](../../../server/configuration/configuration-options.mdx#settingsjson) file so that we can perform the setup remotely using the browser. Notice that when we run the server for the first time, `settings.json` is created from `settings.default.json`. So if `settings.json` doesn't exist, edit `settings.default.json` instead. @@ -236,7 +236,7 @@ Access the certificate view to see both the loaded server certificate and the ad Congratulations! You have a secure RavenDB server running on a simple EC2 machine. -Don't forget to delete the `Security.UnsecuredAccessAllowed` property from [settings.json](../../../server/configuration/configuration-options.mdx#settings.json). It's not necessary anymore because access to the server now requires using a registered client certificate. +Don't forget to delete the `Security.UnsecuredAccessAllowed` property from [settings.json](../../../server/configuration/configuration-options.mdx#settingsjson). It's not necessary anymore because access to the server now requires using a registered client certificate. Connecting a few servers in a cluster is easy. Follow [these instructions](../../../start/installation/setup-wizard.mdx) to construct a cluster during setup. diff --git a/versioned_docs/version-6.2/start/installation/setup-wizard.mdx b/versioned_docs/version-6.2/start/installation/setup-wizard.mdx index 4b8fc9832a..615c4a4953 100644 --- a/versioned_docs/version-6.2/start/installation/setup-wizard.mdx +++ b/versioned_docs/version-6.2/start/installation/setup-wizard.mdx @@ -148,7 +148,7 @@ All 3 nodes will run on the local machine: - Node B (https://b.raven.development.run) will listen to 127.0.0.2 on port 8080. - Node C (https://c.raven.development.run) will listen to 127.0.0.3 on port 8080. -Each node will run in its own process and have its own data directory and [settings.json](../../server/configuration/configuration-options.mdx#settings.json) file. +Each node will run in its own process and have its own data directory and [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) file. You should have 3 separate RavenDB node folders. ### Example II - On separate machines for higher availability @@ -423,7 +423,7 @@ All 3 nodes will run on the local machine: - Node B (https://b.ravendb.example.com) will listen to 127.0.0.2 on port 8080. - Node C (https://c.ravendb.example.com) will listen to 127.0.0.3 on port 8080. -Each node will run in its own process and have its own data directory and [settings.json](../../server/configuration/configuration-options.mdx#settings.json) file. +Each node will run in its own process and have its own data directory and [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) file. ### Example II - On separate machines diff --git a/versioned_docs/version-6.2/start/installation/upgrading-to-new-version.mdx b/versioned_docs/version-6.2/start/installation/upgrading-to-new-version.mdx index 87dcbbb78c..4b53fe4cd7 100644 --- a/versioned_docs/version-6.2/start/installation/upgrading-to-new-version.mdx +++ b/versioned_docs/version-6.2/start/installation/upgrading-to-new-version.mdx @@ -30,7 +30,7 @@ Upgrading a RavenDB instance to a new version is very simple. To do so: 3. Remove old RavenDB binaries * **Avoid** deleting your actual data, contained in folders like `RavenData`. - * **Avoid** overwriting your configuration files, e.g. [settings.json](../../server/configuration/configuration-options.mdx#settings.json). + * **Avoid** overwriting your configuration files, e.g. [settings.json](../../server/configuration/configuration-options.mdx#settingsjson). * **Avoid** deleting your certificate file (ending with `.pfx` or `.pem`). * For additional information see the [certificate page](../../server/security/authentication/certificate-configuration.mdx). * These steps are strictly necessary when updating to version 5.1. @@ -71,7 +71,7 @@ or [External replication](../../studio/database/tasks/ongoing-tasks/external-rep Please read the [migration article](../../migration/server/data-migration.mdx) for additional data and client migration strategies. * If you have a license for a RavenDB version older than `6.x`, upgrading to version `6.0` will require you to upgrade your license key. - * Read [here](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6.x) how to upgrade + * Read [here](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6x) how to upgrade and replace your existing license key. * Read [here](../../migration/server/data-migration.mdx) about migrating from one RavenDB version to another. 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 9233c49897..211a51235b 100644 --- a/versioned_docs/version-6.2/start/licensing/activate-license.mdx +++ b/versioned_docs/version-6.2/start/licensing/activate-license.mdx @@ -30,7 +30,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * You can activate the license using either one of the following configuration keys: * [License](../../server/configuration/license-configuration.mdx#license) - * [License.Path](../../server/configuration/license-configuration.mdx#license.path) + * [License.Path](../../server/configuration/license-configuration.mdx#licensepath) * These configuration keys can be set in _setting.json_ or as environment variables. Learn more in [configuration overview](../../server/configuration/configuration-options.mdx). 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 50f5eb785b..b9e03e3070 100644 --- a/versioned_docs/version-6.2/start/licensing/force-update.mdx +++ b/versioned_docs/version-6.2/start/licensing/force-update.mdx @@ -21,7 +21,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * This automatic update will be applied provided that: * You have an active connection to RavenDB's License Server (api.ravendb.net). - * [DisableAutoUpdate](../../server/configuration/license-configuration.mdx#license.disableautoupdate) is set to false. + * [DisableAutoUpdate](../../server/configuration/license-configuration.mdx#licensedisableautoupdate) is set to false. * If changes were made to your current license and you want to **apply immediately**, then you can **force the update from Studio**. @@ -43,7 +43,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Click the _Force Update_ button. This will update your current license immediately. - * If [DisableAutoUpdateFromApi](../../server/configuration/license-configuration.mdx#license.disableautoupdatefromapi) is set to _true_, + * If [DisableAutoUpdateFromApi](../../server/configuration/license-configuration.mdx#licensedisableautoupdatefromapi) is set to _true_, the license will be updated from the [configuration keys](../../start/licensing/activate-license.mdx#activate-license-with-configuration-keys). If set to _false_, the license will be updated from the [License Server](../../start/licensing/licensing-overview.mdx#license-server), provided you have an active connection. 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 26e584a50b..2f7da0cd33 100644 --- a/versioned_docs/version-6.2/start/licensing/renew-license.mdx +++ b/versioned_docs/version-6.2/start/licensing/renew-license.mdx @@ -34,7 +34,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; **Automatic renewal**: If your server has an active connection to RavenDB's [License Server](../../start/licensing/licensing-overview.mdx#license-server), -and if the [DisableAutoUpdate](../../server/configuration/license-configuration.mdx#license.disableautoupdate) configuration is Not set to true, +and if the [DisableAutoUpdate](../../server/configuration/license-configuration.mdx#licensedisableautoupdate) configuration is Not set to true, then these commercial licenses will be automatically renewed. @@ -50,7 +50,7 @@ Copy the new license key from the mail and proceed with one of the following opt **Or**: -* Set [DisableAutoUpdateFromApi](../../server/configuration/license-configuration.mdx#license.disableautoupdatefromapi) to true. +* Set [DisableAutoUpdateFromApi](../../server/configuration/license-configuration.mdx#licensedisableautoupdatefromapi) to true. * Activate the new license key using the [configuration keys](../../start/licensing/activate-license.mdx#activate-license-with-configuration-keys). 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 8176427693..d57625f066 100644 --- a/versioned_docs/version-6.2/start/licensing/replace-license.mdx +++ b/versioned_docs/version-6.2/start/licensing/replace-license.mdx @@ -22,13 +22,13 @@ 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-6.x) + as explained [below](../../start/licensing/replace-license.mdx#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) * [Maintain auto-renewal of Let's Encrypt certificates](../../start/licensing/replace-license.mdx#maintain-auto-renewal-of-let) - * [Upgrade a License Key For RavenDB 6.x](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6.x) + * [Upgrade a License Key For RavenDB 6.x](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6x) ## Replace license from Studio 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 c121451f55..00cd20edfb 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 @@ -49,7 +49,7 @@ Another way to access the New Database From Backup interface is via the Studio B ![Figure 2. Backup Source Configuration](./assets/new-database-from-backup-2.png) -1. [**Name** your new database](../../../studio/database/create-new-database/general-flow.mdx#2.-database-name). +1. [**Name** your new database](../../../studio/database/create-new-database/general-flow.mdx#2-database-name). 2. **Source** Select the source server type to see the fields necessary to access the backup 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 44408be261..3ee0677ebc 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 @@ -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](../../../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 @@ -35,7 +35,7 @@ Open the down arrow and click `New database from legacy files`. ![Figure 2. Create New Database From Legacy Files - Data Source Configuration](./assets/new-database-from-legacy-2.png) -1. [Database Name](../../../studio/database/create-new-database/general-flow.mdx#2.-database-name) +1. [Database Name](../../../studio/database/create-new-database/general-flow.mdx#2-database-name) 2. **Resource type** * RavenFS files will be saved as documents with attachments in @files collection. 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 c7727ebcbd..de1fcc3b13 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 @@ -16,7 +16,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](../../../studio/database/create-new-database/general-flow.mdx#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). @@ -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](../../../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 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 d6a0caaf2a..8eaa43b152 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 @@ -124,7 +124,7 @@ update \{ * d. **Ignore maximum number of steps for script** By default, a patch script can execute up to a maximum number of steps before throwing an exception. - This limit is set by the [Patching.MaxStepsForScript](../../../server/configuration/patching-configuration.mdx#patching.maxstepsforscript) configuration key (default: 10,000). + This limit is set by the [Patching.MaxStepsForScript](../../../server/configuration/patching-configuration.mdx#patchingmaxstepsforscript) configuration key (default: 10,000). Toggle this option ON to ignore the limit. * e. **Limit number of operations** 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 e7d769edf0..534ac5240a 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 @@ -171,7 +171,7 @@ Indexing can be a taxing operation on CPU resources. There are a number of [configurations](../../../server/configuration/indexing-configuration.mdx) that efficiently use batch stops to break up huge batch processes into smaller batches to prevent exhausting resources. If a configuration is specific to an index, it can be [set in the Studio](../../../studio/database/indexes/create-map-index.mdx#configuration). -If it is a server-wide only configuration, it must be set in the server's [settings.json](../../../server/configuration/configuration-options.mdx#settings.json). +If it is a server-wide only configuration, it must be set in the server's [settings.json](../../../server/configuration/configuration-options.mdx#settingsjson). While they prevent system exhaustion, batch stops also point to potential **opportunities to optimize** your indexes. @@ -188,18 +188,18 @@ Some indexes are responsible for a huge dataset and/or have very complex, demand 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: -- [Indexing.MapTimeoutInSec](../../../server/configuration/indexing-configuration.mdx#indexing.maptimeoutinsec) +- [Indexing.MapTimeoutInSec](../../../server/configuration/indexing-configuration.mdx#indexingmaptimeoutinsec) Number of seconds after which mapping will end even if there is more to map. -- [Indexing.MapTimeoutAfterEtagReachedInMin](../../../server/configuration/indexing-configuration.mdx#indexing.maptimeoutafteretagreachedinmin) +- [Indexing.MapTimeoutAfterEtagReachedInMin](../../../server/configuration/indexing-configuration.mdx#indexingmaptimeoutafteretagreachedinmin) This will only be applied if we pass the last [etag](../../../glossary/etag.mdx) in collection that we saw when batch was started. -- [Indexing.MapBatchSize](../../../server/configuration/indexing-configuration.mdx#indexing.mapbatchsize) +- [Indexing.MapBatchSize](../../../server/configuration/indexing-configuration.mdx#indexingmapbatchsize) Maximum number of documents to be processed by the index per indexing batch. #### Low Memory -* [Low Memory](../../../server/configuration/memory-configuration.mdx#memory.lowmemorylimitinmb) 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](../../../studio/database/indexes/indexing-performance.mdx#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#indexing.mapbatchsize) that you can configure + * Until then, there are a number of [indexing configurations](../../../server/configuration/indexing-configuration.mdx#indexingmapbatchsize) that you can configure to break up processes into smaller batches. * **Cloud server** Your indexing process will continue until it is finished, but will be broken up into smaller batches and continue when enough CPU credits accumulate. @@ -213,7 +213,7 @@ You can configure [batch stops](../../../studio/database/indexes/indexing-perfor [externally replicate](../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx) to new instances, and/or optimize your indexes. #### Concurrent Processing of Too Many Indexes -- [Limit concurrent index processes](../../../server/configuration/indexing-configuration.mdx#indexing.maxnumberofconcurrentlyrunningindexes) - +- [Limit concurrent index processes](../../../server/configuration/indexing-configuration.mdx#indexingmaxnumberofconcurrentlyrunningindexes) - RavenDB can handle multiple index processes at the same time, but if there are too many, it will exhaust the system resources and cause a noticeable slow-down. The `Indexing.MaxNumberOfConcurrentlyRunningIndexes` method enables you to have many indexes without exhausting resources by allowing you to set the number of concurrent index processes. 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 bb1d986fe6..72f050e5af 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 @@ -57,7 +57,7 @@ Do not modify the database settings unless you are an expert and know what you'r * Only the **database scope** configuration keys can be edited from this view. Configuration keys that relate only to the **server scope** are edited in the - [`settings.json` file](../../../server/configuration/configuration-options.mdx#settings.json) + [`settings.json` file](../../../server/configuration/configuration-options.mdx#settingsjson) and can only be viewed here. * Once you save the changes made in this view, all modifications are saved into the @@ -73,7 +73,7 @@ Do not modify the database settings unless you are an expert and know what you'r 3. This column lists the **Configuration Keys** in the selected Category. 4. This column lists the current **Value** set for the key. 5. The lock icon indicates that this key is server scoped and can not be modified here. - It can be edited only from the [`settings.json` file](../../../server/configuration/configuration-options.mdx#settings.json) + It can be edited only from the [`settings.json` file](../../../server/configuration/configuration-options.mdx#settingsjson) located in your RavenDB executable folder. 6. Toggle to override the current value of this key. 7. Use the edit box to customize the value. 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 050160aea3..441a93e869 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 @@ -20,7 +20,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Learn more in this [overview](../../../server/storage/documents-compression.mdx#overview). * Documents compression can be set for all collections, selected collections, and revisions. - Default compression settings are [configurable](../../../server/configuration/database-configuration.mdx#databases.compression.compressallcollectionsdefault). + Default compression settings are [configurable](../../../server/configuration/database-configuration.mdx#databasescompressioncompressallcollectionsdefault). * When turned on, compression will be applied to: * **New documents**: 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 c528fd6ec7..dd203aa8e7 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 @@ -18,9 +18,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * The Studio Configuration view enables configuration of studio-related operations and interfaces. * Settings changed in this view do not change configurations in other scopes such as Client or Server API. - * To disable the creation of Auto-Indexes in other scopes, set [Indexing.DisableQueryOptimizerGeneratedIndexes](../../../server/configuration/indexing-configuration.mdx#indexing.disablequeryoptimizergeneratedindexes) + * To disable the creation of Auto-Indexes in other scopes, set [Indexing.DisableQueryOptimizerGeneratedIndexes](../../../server/configuration/indexing-configuration.mdx#indexingdisablequeryoptimizergeneratedindexes) to `true`: - * Server-wide - set it in the server's [settings.json](../../../server/configuration/configuration-options.mdx#settings.json) file. + * Server-wide - set it in the server's [settings.json](../../../server/configuration/configuration-options.mdx#settingsjson) file. * Per database - set it in the database's [Document Store](../../../client-api/operations/maintenance/configuration/database-settings-operation.mdx). In this page: @@ -88,9 +88,9 @@ In this page: * Note: dynamic queries can be issued either when [querying](../../../studio/database/queries/query-view.mdx#query-view) or when [patching](../../../studio/database/documents/patch-view.mdx#patch-configuration). * Auto-indexes are dynamically maintained to change automatically in response to changing query demands. - After a certain amount of time that an auto-index is not used [(30 minutes by default)](../../../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforemarkingautoindexasidleinmin), + After a certain amount of time that an auto-index is not used [(30 minutes by default)](../../../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforemarkingautoindexasidleinmin), the index goes into an [idle state](../../../studio/database/indexes/indexes-list-view.mdx#index-state) - and deleted after a set time-period [(72 hours by default)](../../../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforedeletingautoindexmarkedasidleinhrs). + and deleted after a set time-period [(72 hours by default)](../../../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforedeletingautoindexmarkedasidleinhrs). * To provide for fast queries, indexes process information in the background. If they are processing large datasets, each index can be demanding on I/O resources. @@ -114,7 +114,7 @@ temporarily allow Auto-Index in the Query or Patch settings interface. Note: These settings only affect Auto-Indexing as a result of Queries or Patches done in the Studio. They do not affect API-based Queries or Patches. -To configure API-based Auto-Indexing, see [Indexing.DisableQueryOptimizerGeneratedIndexes](../../../server/configuration/indexing-configuration.mdx#indexing.disablequeryoptimizergeneratedindexes) +To configure API-based Auto-Indexing, see [Indexing.DisableQueryOptimizerGeneratedIndexes](../../../server/configuration/indexing-configuration.mdx#indexingdisablequeryoptimizergeneratedindexes) @@ -132,7 +132,7 @@ To configure API-based Auto-Indexing, see [Indexing.DisableQueryOptimizerGenerat Choose work environment. This does not affect settings or features. It makes it clear if, for example, you are in a production server and should be much more careful than in a development environment. 4. **Default replication factor** - Change the default [replication factor](../../../studio/database/create-new-database/general-flow.mdx#3.-configure-replication) from + Change the default [replication factor](../../../studio/database/create-new-database/general-flow.mdx#3-configure-replication) from automatically replicating data to every node in the cluster. 5. **Help us improve the Studio** Allow the Studio to send usage statistics to inform our developers. 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 127346a8f8..84819a1b63 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 @@ -34,7 +34,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * To create sample data, you can either empty your playground database or [create a new database](../../../studio/database/create-new-database/general-flow.mdx). -* If you plan to use [multiple nodes](../../../studio/database/create-new-database/general-flow.mdx#3.-configure-replication) +* If you plan to use [multiple nodes](../../../studio/database/create-new-database/general-flow.mdx#3-configure-replication) and/or [encryption](../../../studio/database/create-new-database/encrypted.mdx) in production, we recommend installing your playground database in a similar environment. 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 e8ddbd8f2c..8a333adac3 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 @@ -25,7 +25,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Download Raven.Migrator Tool](../../../../studio/database/tasks/import-data/import-from-other.mdx#download-raven.migrator-tool) + * [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) @@ -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-raven.migrator-tool). + * Find `Raven.Migrator.exe` in the [tools package](../../../../studio/database/tasks/import-data/import-from-other.mdx#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-raven.migrator-tool). + * Find `Raven.Migrator.exe` in the [tools package](../../../../studio/database/tasks/import-data/import-from-other.mdx#download-ravenmigrator-tool). * Provide a path to `Raven.Migrator.exe`'s folder. 2. **Database Source** 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 1bf4ef1d58..8f566ba1fd 100644 --- a/versioned_docs/version-6.2/studio/server/server-settings.mdx +++ b/versioned_docs/version-6.2/studio/server/server-settings.mdx @@ -19,7 +19,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; hosted by the server. * This is a **read-only** view, showing settings made using [environment variables](../../server/configuration/configuration-options.mdx#environment-variables), - the [settings.json](../../server/configuration/configuration-options.mdx#settings.json) + the [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) configuration file, and [command line arguments](../../server/configuration/configuration-options.mdx#command-line-arguments). * For the server settings view open **Manage Server** `>>` **Server Settings** * To modify the settings of individual databases use the [Database Settings](../../studio/database/settings/database-settings.mdx) view. diff --git a/versioned_docs/version-7.0/ai-integration/connection-strings/azure-open-ai.mdx b/versioned_docs/version-7.0/ai-integration/connection-strings/azure-open-ai.mdx index 2a2fa4cc4d..628745c087 100644 --- a/versioned_docs/version-7.0/ai-integration/connection-strings/azure-open-ai.mdx +++ b/versioned_docs/version-7.0/ai-integration/connection-strings/azure-open-ai.mdx @@ -65,7 +65,7 @@ export const supportedLanguages = ["csharp"]; * When making vector search queries, the content of the search terms must also be converted to embeddings to compare them against the stored vectors. Requests to generate such query embeddings via the AI provider are sent in batches. * This parameter defines the maximum number of these batches that can be processed concurrently. - You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#ai.embeddings.maxconcurrentbatches) configuration key. + You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#aiembeddingsmaxconcurrentbatches) configuration key. 10. Click **Test Connection** to confirm the connection string is set up correctly. diff --git a/versioned_docs/version-7.0/ai-integration/connection-strings/embedded.mdx b/versioned_docs/version-7.0/ai-integration/connection-strings/embedded.mdx index 8b3f86c675..b960fd455a 100644 --- a/versioned_docs/version-7.0/ai-integration/connection-strings/embedded.mdx +++ b/versioned_docs/version-7.0/ai-integration/connection-strings/embedded.mdx @@ -51,7 +51,7 @@ export const supportedLanguages = ["csharp"]; * When making vector search queries, the content of the search terms must also be converted to embeddings to compare them against the stored vectors. Requests to generate such query embeddings via the AI provider are sent in batches. * This parameter defines the maximum number of these batches that can be processed concurrently. - You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#ai.embeddings.maxconcurrentbatches) configuration key. + You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#aiembeddingsmaxconcurrentbatches) configuration key. 5. Click **Save** to store the connection string or **Cancel** to discard changes. diff --git a/versioned_docs/version-7.0/ai-integration/connection-strings/google-ai.mdx b/versioned_docs/version-7.0/ai-integration/connection-strings/google-ai.mdx index b747fc1d86..b733664544 100644 --- a/versioned_docs/version-7.0/ai-integration/connection-strings/google-ai.mdx +++ b/versioned_docs/version-7.0/ai-integration/connection-strings/google-ai.mdx @@ -64,7 +64,7 @@ export const supportedLanguages = ["csharp"]; * When making vector search queries, the content of the search terms must also be converted to embeddings to compare them against the stored vectors. Requests to generate such query embeddings via the AI provider are sent in batches. * This parameter defines the maximum number of these batches that can be processed concurrently. - You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#ai.embeddings.maxconcurrentbatches) configuration key. + You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#aiembeddingsmaxconcurrentbatches) configuration key. 9. Click **Test Connection** to confirm the connection string is set up correctly. diff --git a/versioned_docs/version-7.0/ai-integration/connection-strings/hugging-face.mdx b/versioned_docs/version-7.0/ai-integration/connection-strings/hugging-face.mdx index 43dac1dd0a..f7ff6e06e9 100644 --- a/versioned_docs/version-7.0/ai-integration/connection-strings/hugging-face.mdx +++ b/versioned_docs/version-7.0/ai-integration/connection-strings/hugging-face.mdx @@ -58,7 +58,7 @@ export const supportedLanguages = ["csharp"]; * When making vector search queries, the content of the search terms must also be converted to embeddings to compare them against the stored vectors. Requests to generate such query embeddings via the AI provider are sent in batches. * This parameter defines the maximum number of these batches that can be processed concurrently. - You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#ai.embeddings.maxconcurrentbatches) configuration key. + You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#aiembeddingsmaxconcurrentbatches) configuration key. 8. Click **Test Connection** to confirm the connection string is set up correctly. diff --git a/versioned_docs/version-7.0/ai-integration/connection-strings/mistral-ai.mdx b/versioned_docs/version-7.0/ai-integration/connection-strings/mistral-ai.mdx index 203e06b092..632350c706 100644 --- a/versioned_docs/version-7.0/ai-integration/connection-strings/mistral-ai.mdx +++ b/versioned_docs/version-7.0/ai-integration/connection-strings/mistral-ai.mdx @@ -56,7 +56,7 @@ export const supportedLanguages = ["csharp"]; * When making vector search queries, the content of the search terms must also be converted to embeddings to compare them against the stored vectors. Requests to generate such query embeddings via the AI provider are sent in batches. * This parameter defines the maximum number of these batches that can be processed concurrently. - You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#ai.embeddings.maxconcurrentbatches) configuration key. + You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#aiembeddingsmaxconcurrentbatches) configuration key. 8. Click **Test Connection** to confirm the connection string is set up correctly. diff --git a/versioned_docs/version-7.0/ai-integration/connection-strings/ollama.mdx b/versioned_docs/version-7.0/ai-integration/connection-strings/ollama.mdx index 65fe5d1e82..f7b644b1b7 100644 --- a/versioned_docs/version-7.0/ai-integration/connection-strings/ollama.mdx +++ b/versioned_docs/version-7.0/ai-integration/connection-strings/ollama.mdx @@ -53,7 +53,7 @@ export const supportedLanguages = ["csharp"]; * When making vector search queries, the content of the search terms must also be converted to embeddings to compare them against the stored vectors. Requests to generate such query embeddings via the AI provider are sent in batches. * This parameter defines the maximum number of these batches that can be processed concurrently. - You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#ai.embeddings.maxconcurrentbatches) configuration key. + You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#aiembeddingsmaxconcurrentbatches) configuration key. 7. Click **Test Connection** to confirm the connection string is set up correctly. diff --git a/versioned_docs/version-7.0/ai-integration/connection-strings/open-ai.mdx b/versioned_docs/version-7.0/ai-integration/connection-strings/open-ai.mdx index 1464807a7c..0bff5bc0d8 100644 --- a/versioned_docs/version-7.0/ai-integration/connection-strings/open-ai.mdx +++ b/versioned_docs/version-7.0/ai-integration/connection-strings/open-ai.mdx @@ -79,7 +79,7 @@ export const supportedLanguages = ["csharp"]; * When making vector search queries, the content of the search terms must also be converted to embeddings to compare them against the stored vectors. Requests to generate such query embeddings via the AI provider are sent in batches. * This parameter defines the maximum number of these batches that can be processed concurrently. - You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#ai.embeddings.maxconcurrentbatches) configuration key. + You can set a default value using the [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#aiembeddingsmaxconcurrentbatches) configuration key. 11. Click **Test Connection** to confirm the connection string is set up correctly. diff --git a/versioned_docs/version-7.0/ai-integration/generating-embeddings/overview.mdx b/versioned_docs/version-7.0/ai-integration/generating-embeddings/overview.mdx index 6e982f3cb8..db52d9517d 100644 --- a/versioned_docs/version-7.0/ai-integration/generating-embeddings/overview.mdx +++ b/versioned_docs/version-7.0/ai-integration/generating-embeddings/overview.mdx @@ -71,9 +71,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Embeddings generation tasks are [Ongoing Tasks](../../studio/database/tasks/ongoing-tasks/general-info.mdx) that process documents as they change. Before contacting the provider after a document change, the task first checks the cache to see if a matching embedding already exists, avoiding unnecessary requests. * The requests to generate embeddings from the source text are sent to the provider in batches. - The batch size is configurable, see the [Ai.Embeddings.MaxBatchSize](../../server/configuration/ai-integration-configuration.mdx#ai.embeddings.maxbatchsize) configuration key. + The batch size is configurable, see the [Ai.Embeddings.MaxBatchSize](../../server/configuration/ai-integration-configuration.mdx#aiembeddingsmaxbatchsize) configuration key. * A failed embeddings generation task will retry after the duration set in the - [Ai.Embeddings.MaxFallbackTimeInSec](../../server/configuration/ai-integration-configuration.mdx#ai.embeddings.maxfallbacktimeinsec) configuration key. + [Ai.Embeddings.MaxFallbackTimeInSec](../../server/configuration/ai-integration-configuration.mdx#aiembeddingsmaxfallbacktimeinsec) configuration key. @@ -126,8 +126,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * The number of embeddings generation tasks across all databases can also be monitored using [SNMP](../../server/administration/snmp/snmp-overview.mdx). The following SNMP OIDs provide relevant metrics: - * [5.1.11.25](../../server/administration/snmp/snmp-overview.mdx#5.1.11.25) – Total number of enabled embeddings generation tasks. - * [5.1.11.26](../../server/administration/snmp/snmp-overview.mdx#5.1.11.26) – Total number of active embeddings generation tasks. + * [5.1.11.25](../../server/administration/snmp/snmp-overview.mdx#511125) – Total number of enabled embeddings generation tasks. + * [5.1.11.26](../../server/administration/snmp/snmp-overview.mdx#511126) – Total number of active embeddings generation tasks. diff --git a/versioned_docs/version-7.0/ai-integration/vector-search/vector-search-using-dynamic-query.mdx b/versioned_docs/version-7.0/ai-integration/vector-search/vector-search-using-dynamic-query.mdx index 1b59f8275e..c17dfd9dbd 100644 --- a/versioned_docs/version-7.0/ai-integration/vector-search/vector-search-using-dynamic-query.mdx +++ b/versioned_docs/version-7.0/ai-integration/vector-search/vector-search-using-dynamic-query.mdx @@ -123,7 +123,7 @@ export const supportedLanguages = ["csharp"]; * **Search results**: By default, the resulting documents will be ordered by their score. - You can modify this behavior using the [Indexing.Corax.VectorSearch.OrderByScoreAutomatically](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.orderbyscoreautomatically) configuration key. + You can modify this behavior using the [Indexing.Corax.VectorSearch.OrderByScoreAutomatically](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchorderbyscoreautomatically) configuration key. In addition, you can apply any of the 'order by' methods to your query, as explained in [sort query results](../../client-api/session/querying/sort-query-results.mdx). @@ -147,7 +147,7 @@ export const supportedLanguages = ["csharp"]; it is recommended to explicitly specify the minimum similarity level at query time. If not specified, the default value is taken from the following configuration key: - [Indexing.Corax.VectorSearch.DefaultMinimumSimilarity](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultminimumsimilarity). + [Indexing.Corax.VectorSearch.DefaultMinimumSimilarity](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultminimumsimilarity). * **Number of candidates** You can specify the maximum number of vectors that RavenDB will return from a graph search. @@ -156,7 +156,7 @@ export const supportedLanguages = ["csharp"]; * higher than the number of candidates - when the same vector is shared between multiple documents. If not specified, the default value is taken from the following configuration key: - [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultnumberofcandidatesforquerying). + [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofcandidatesforquerying). * **Search method** * _Approximate Nearest-Neighbor search_ (Default): @@ -172,7 +172,7 @@ export const supportedLanguages = ["csharp"]; #### Corax auto-indexes * Only [Corax indexes](../../indexes/search-engine/corax.mdx) support vector search. -* Even if your **default auto-index engine** is set to Lucene (via [Indexing.Auto.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexing.auto.searchenginetype)), +* Even if your **default auto-index engine** is set to Lucene (via [Indexing.Auto.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexingautosearchenginetype)), performing a vector search using a dynamic query will create a new auto-index based on Corax. * Normally, new dynamic queries extend existing [auto-indexes](../../client-api/session/querying/how-to-query.mdx#queries-always-provide-results-using-an-index) if they require additional fields. @@ -1501,8 +1501,8 @@ and (vector.search(embedding.text(Name), $searchTerm, 0.75, 25)) * You can combine multiple vector search statements in the same query using logical operators. This is useful when you want to retrieve documents that match more than one vector-based criterion. -* This can be done using [DocumentQuery](../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery), - [RawQuery](../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) or raw [RQL](../../client-api/session/querying/what-is-rql.mdx). +* This can be done using [DocumentQuery](../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery), + [RawQuery](../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) or raw [RQL](../../client-api/session/querying/what-is-rql.mdx). * In the example below, the results will include companies that match one of two vector search conditions: * Companies from European countries with a _Name_ similar to "snack" @@ -1653,7 +1653,7 @@ or * 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). - * If not specified, it is taken from the [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultnumberofcandidatesforquerying) configuration key (default is 16). + * 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. @@ -1707,10 +1707,10 @@ public IRavenQueryable VectorSearch( The default value for `minimumSimilarity` is defined by this configuration key: -[Indexing.Corax.VectorSearch.DefaultMinimumSimilarity ](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultnumberofcandidatesforquerying). +[Indexing.Corax.VectorSearch.DefaultMinimumSimilarity ](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofcandidatesforquerying). The default value for `numberOfCandidates` is defined by this configuration key: -[Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultminimumsimilarity). +[Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultminimumsimilarity). `IVectorFieldFactory`: diff --git a/versioned_docs/version-7.0/ai-integration/vector-search/vector-search-using-static-index.mdx b/versioned_docs/version-7.0/ai-integration/vector-search/vector-search-using-static-index.mdx index 19f445692a..bb264e03d4 100644 --- a/versioned_docs/version-7.0/ai-integration/vector-search/vector-search-using-static-index.mdx +++ b/versioned_docs/version-7.0/ai-integration/vector-search/vector-search-using-static-index.mdx @@ -92,11 +92,11 @@ For numerical input only - define the size of the array from your source documen **Number of edges** - Specify the number of edges that will be created for a vector during indexing. -If not specified, the default value is taken from the following configuration key: [Indexing.Corax.VectorSearch.DefaultNumberOfEdges](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultnumberofedges). +If not specified, the default value is taken from the following configuration key: [Indexing.Corax.VectorSearch.DefaultNumberOfEdges](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofedges). **Number of candidates for indexing time** - The number of candidates (potential neighboring vectors) that RavenDB evaluates during vector indexing. -If not specified, the default value is taken from the following configuration key: [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForIndexing](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultnumberofcandidatesforindexing). +If not specified, the default value is taken from the following configuration key: [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForIndexing](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofcandidatesforindexing). (Note, this param differs from the number of candidates for query time). @@ -127,7 +127,7 @@ enabling efficient retrieval of Approximate Nearest Neighbors (ANN) during queri **Minimum similarity** - You can specify the minimum similarity to use when searching for related vectors. Can be a value between `0.0f` and `1.0f`. A value closer to `1.0f` requires higher similarity between vectors, while a value closer to `0.0f` allows for less similarity. -If not specified, the default value is taken from the following configuration key: [Indexing.Corax.VectorSearch.DefaultMinimumSimilarity](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultminimumsimilarity). +If not specified, the default value is taken from the following configuration key: [Indexing.Corax.VectorSearch.DefaultMinimumSimilarity](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultminimumsimilarity). **Number of candidates at query time** - You can specify the maximum number of vectors that RavenDB will return from a graph search. @@ -137,7 +137,7 @@ The number of the resulting documents that correspond to these vectors may be: * higher than the number of candidates - when the same vector is shared between multiple documents. -If not specified, the default value is taken from the following configuration key: [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultnumberofcandidatesforquerying). +If not specified, the default value is taken from the following configuration key: [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofcandidatesforquerying). **Search method** - You can specify the search method at query time: @@ -156,7 +156,7 @@ The server will search for the most similar vectors in the indexed vector space, The documents that correspond to the resulting vectors are then returned to the client. By default, the resulting documents will be ordered by their score. -You can modify this behavior using the [Indexing.Corax.VectorSearch.OrderByScoreAutomatically](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.orderbyscoreautomatically) configuration key. +You can modify this behavior using the [Indexing.Corax.VectorSearch.OrderByScoreAutomatically](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchorderbyscoreautomatically) configuration key. In addition, you can apply any of the 'order by' methods to your query, as explained in [sort query results](../../client-api/session/querying/sort-query-results.mdx). diff --git a/versioned_docs/version-7.0/ai-integration/vector-search/what-affects-vector-search-results.mdx b/versioned_docs/version-7.0/ai-integration/vector-search/what-affects-vector-search-results.mdx index 61568007ae..e0a03e06cf 100644 --- a/versioned_docs/version-7.0/ai-integration/vector-search/what-affects-vector-search-results.mdx +++ b/versioned_docs/version-7.0/ai-integration/vector-search/what-affects-vector-search-results.mdx @@ -94,7 +94,7 @@ They help keep memory usage and indexing time under control, but may also limit * With **static-indexes** - This param can be set directly in the index definition. For example, see this [index definition](../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-raw-text). If not explicitly set, or when using **dynamic queries** - - the value is taken from the [Indexing.Corax.VectorSearch.DefaultNumberOfEdges](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultnumberofedges) configuration key. + the value is taken from the [Indexing.Corax.VectorSearch.DefaultNumberOfEdges](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofedges) configuration key. * **Number of candidates at indexing time**: @@ -109,7 +109,7 @@ They help keep memory usage and indexing time under control, but may also limit * With **static-indexes** - This param can be set directly in the index definition. For example, see this [index definition](../../ai-integration/vector-search/vector-search-using-static-index.mdx#indexing-raw-text). If not explicitly set, or when using **dynamic queries** - - the value is taken from the [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForIndexing](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultnumberofcandidatesforindexing) configuration key. + the value is taken from the [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForIndexing](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofcandidatesforindexing) configuration key. For all parameters that can be defined at indexing time (including the ones above), see [Parameters defined at index definition](../../ai-integration/vector-search/vector-search-using-static-index.mdx#parameters-defined-at-index-definition). @@ -129,7 +129,7 @@ These parameters directly affect how many results are found, how similar they ar and typically improving accuracy and the chances of retrieving all relevant results - but this comes at the cost of slower query performance. A **smaller** value speeds up queries and reduces resource usage, but increases the chance of missing relevant results due to the more limited exploration. * This param can be set directly in the query. For example, see this [Query example](../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-raw-text). - If not explicitly set, the value is taken from the [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultnumberofcandidatesforquerying) configuration key. + If not explicitly set, the value is taken from the [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultnumberofcandidatesforquerying) configuration key. * **Minimum Similarity**: @@ -138,7 +138,7 @@ These parameters directly affect how many results are found, how similar they ar even if they would otherwise be among the top candidates. Use this to filter out marginal matches, especially when minimum semantic relevance is important. * This param can be set directly in the query. For example, see this [Query example](../../ai-integration/vector-search/vector-search-using-dynamic-query.mdx#querying-raw-text). - If not explicitly set in the query, the value is taken from the [Indexing.Corax.VectorSearch.DefaultMinimumSimilarity](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultminimumsimilarity) configuration key. + If not explicitly set in the query, the value is taken from the [Indexing.Corax.VectorSearch.DefaultMinimumSimilarity](../../server/configuration/indexing-configuration.mdx#indexingcoraxvectorsearchdefaultminimumsimilarity) configuration key. The default value of this configuration key is `0.0`, which means no similarity filtering is applied - all candidates found during the search are eligible to be returned, regardless of how dissimilar they are from the query vector. diff --git a/versioned_docs/version-7.0/client-api/changes/what-is-changes-api.mdx b/versioned_docs/version-7.0/client-api/changes/what-is-changes-api.mdx index 8e9a9aa5df..588f87a629 100644 --- a/versioned_docs/version-7.0/client-api/changes/what-is-changes-api.mdx +++ b/versioned_docs/version-7.0/client-api/changes/what-is-changes-api.mdx @@ -183,7 +183,7 @@ finally #### Changes API and Database Timeout One or more open Changes API connections will prevent a database from becoming -idle and unloaded, regardless of [the configuration value for database idle timeout](../../server/configuration/database-configuration.mdx#databases.maxidletimeinsec). +idle and unloaded, regardless of [the configuration value for database idle timeout](../../server/configuration/database-configuration.mdx#databasesmaxidletimeinsec). #### Changes API and Method Overloads @@ -343,7 +343,7 @@ try \{ One or more open Changes API connections will prevent a database from becoming -idle and unloaded, regardless of [the configuration value for database idle timeout](../../server/configuration/database-configuration.mdx#databases.maxidletimeinsec). +idle and unloaded, regardless of [the configuration value for database idle timeout](../../server/configuration/database-configuration.mdx#databasesmaxidletimeinsec). @@ -492,7 +492,7 @@ try \{ #### Changes API and Database Timeout One or more open Changes API connections will prevent a database from becoming -idle and unloaded, regardless of [the configuration value for database idle timeout](../../server/configuration/database-configuration.mdx#databases.maxidletimeinsec). +idle and unloaded, regardless of [the configuration value for database idle timeout](../../server/configuration/database-configuration.mdx#databasesmaxidletimeinsec). #### Changes API and Method Overloads diff --git a/versioned_docs/version-7.0/client-api/configuration/conventions.mdx b/versioned_docs/version-7.0/client-api/configuration/conventions.mdx index 57da35a0d3..6b96429f83 100644 --- a/versioned_docs/version-7.0/client-api/configuration/conventions.mdx +++ b/versioned_docs/version-7.0/client-api/configuration/conventions.mdx @@ -28,8 +28,8 @@ export const supportedLanguages = ["csharp", "nodejs"]; * [How to set conventions](../../client-api/configuration/conventions.mdx#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#aggressivecache.duration) - [AggressiveCache.Mode](../../client-api/configuration/conventions.mdx#aggressivecache.mode) + [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) diff --git a/versioned_docs/version-7.0/client-api/configuration/serialization.mdx b/versioned_docs/version-7.0/client-api/configuration/serialization.mdx index 08ae36a0ae..9e723ea7a3 100644 --- a/versioned_docs/version-7.0/client-api/configuration/serialization.mdx +++ b/versioned_docs/version-7.0/client-api/configuration/serialization.mdx @@ -27,7 +27,7 @@ by which entities are serialized as they are sent by the client to the server. * In this page: * [CustomizeJsonSerializer](../../client-api/configuration/serialization.mdx#customizejsonserializer) * [JsonContractResolver](../../client-api/configuration/serialization.mdx#jsoncontractresolver) - * [BulkInsert.TrySerializeEntityToJsonStream](../../client-api/configuration/serialization.mdx#bulkinsert.tryserializeentitytojsonstream) + * [BulkInsert.TrySerializeEntityToJsonStream](../../client-api/configuration/serialization.mdx#bulkinserttryserializeentitytojsonstream) * [IgnoreByRefMembers and IgnoreUnsafeMembers](../../client-api/configuration/serialization.mdx#ignorebyrefmembers-and-ignoreunsafemembers) diff --git a/versioned_docs/version-7.0/client-api/data-subscriptions/consumption/api-overview.mdx b/versioned_docs/version-7.0/client-api/data-subscriptions/consumption/api-overview.mdx index 9e6dc1290f..276946a9b6 100644 --- a/versioned_docs/version-7.0/client-api/data-subscriptions/consumption/api-overview.mdx +++ b/versioned_docs/version-7.0/client-api/data-subscriptions/consumption/api-overview.mdx @@ -26,7 +26,7 @@ export const supportedLanguages = ["csharp", "java", "python", "nodejs"]; * [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>) - * [SubscriptionBatch<T>.Item](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatch<t>.item) + * [SubscriptionBatch<T>.Item](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatch<t>item) * [SubscriptionWorker<T>](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionworker<t>) @@ -160,7 +160,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#subscriptionbatch<t>.item) below. | +| **Items** | `List.Item>` | List of items in the batch.
See [SubscriptionBatch<T>.Item](../../../client-api/data-subscriptions/consumption/api-overview.mdx#subscriptionbatch<t>item) below. | | **NumberOfItemsInBatch** | `int` | Number of items in the batch. | | Method Signature | Return value | Description | diff --git a/versioned_docs/version-7.0/client-api/faq/backward-compatibility.mdx b/versioned_docs/version-7.0/client-api/faq/backward-compatibility.mdx index 617ccc77b4..a9f841bd0d 100644 --- a/versioned_docs/version-7.0/client-api/faq/backward-compatibility.mdx +++ b/versioned_docs/version-7.0/client-api/faq/backward-compatibility.mdx @@ -23,11 +23,11 @@ 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-4.1) - * [Compatibility - RavenDB 4.2 and Higher](../../client-api/faq/backward-compatibility.mdx#compatibility---ravendb-4.2-and-higher) + * [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-4.1) - * [Upgrading - RavenDB 4.2 and Higher](../../client-api/faq/backward-compatibility.mdx#upgrading---ravendb-4.2-and-higher) + * [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) @@ -81,7 +81,7 @@ page to learn more about migrating from early versions. ### 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#ravendb-4.2-and-higher-compatibility). +are [compatible with servers of versions higher than theirs](../../client-api/faq/backward-compatibility.mdx#ravendb-42-and-higher-compatibility). ### 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.0/client-api/operations/common/delete-by-query.mdx b/versioned_docs/version-7.0/client-api/operations/common/delete-by-query.mdx index a8e114889d..d33d92b86a 100644 --- a/versioned_docs/version-7.0/client-api/operations/common/delete-by-query.mdx +++ b/versioned_docs/version-7.0/client-api/operations/common/delete-by-query.mdx @@ -40,7 +40,7 @@ export const supportedLanguages = ["csharp", "java", "python", "php", "nodejs"]; * To avoid issues when recreating such documents using a cluster-wide session, see [Best practice when storing a document](../../../client-api/session/cluster-transaction/atomic-guards.mdx#best-practice-when-storing-a-document-in-a-cluster-wide-transaction). * 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). + 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) @@ -551,7 +551,7 @@ so it can happen than a document has been updated or deleted meanwhile. * To avoid issues when recreating such documents using a cluster-wide session, see [Best practice when storing a document](../../../client-api/session/cluster-transaction/atomic-guards.mdx#best-practice-when-storing-a-document-in-a-cluster-wide-transaction). * 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). + 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) @@ -754,7 +754,7 @@ document_id_that_was_deleted = details[0]["Id"] * To avoid issues when recreating such documents using a cluster-wide session, see [Best practice when storing a document](../../../client-api/session/cluster-transaction/atomic-guards.mdx#best-practice-when-storing-a-document-in-a-cluster-wide-transaction). * 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). + 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) @@ -1046,7 +1046,7 @@ $documentIdThatWasDeleted = $details[0]->getId(); * To avoid issues when recreating such documents using a cluster-wide session, see [Best practice when storing a document](../../../client-api/session/cluster-transaction/atomic-guards.mdx#best-practice-when-storing-a-document-in-a-cluster-wide-transaction). * 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). + 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) diff --git a/versioned_docs/version-7.0/client-api/operations/compare-exchange/include-compare-exchange.mdx b/versioned_docs/version-7.0/client-api/operations/compare-exchange/include-compare-exchange.mdx index d74440f32a..83cb0d9486 100644 --- a/versioned_docs/version-7.0/client-api/operations/compare-exchange/include-compare-exchange.mdx +++ b/versioned_docs/version-7.0/client-api/operations/compare-exchange/include-compare-exchange.mdx @@ -596,7 +596,7 @@ select includeCmpXchg(c) * Note: - Similar to the above dynamic query example, you can query the index with a [raw query](../../../indexes/querying/query-index.mdx#session.advanced.rawquery) using the provided RQL. + Similar to the above dynamic query example, you can query the index with a [raw query](../../../indexes/querying/query-index.mdx#sessionadvancedrawquery) using the provided RQL. diff --git a/versioned_docs/version-7.0/client-api/operations/compare-exchange/overview.mdx b/versioned_docs/version-7.0/client-api/operations/compare-exchange/overview.mdx index f8fadc6c84..f7845eac52 100644 --- a/versioned_docs/version-7.0/client-api/operations/compare-exchange/overview.mdx +++ b/versioned_docs/version-7.0/client-api/operations/compare-exchange/overview.mdx @@ -79,7 +79,7 @@ Compare exchange items are created and managed with any of the following approac * **Atomic Guards** When creating documents using a cluster-wide session RavenDB automatically creates [Atomic Guards](../../../client-api/session/cluster-transaction/atomic-guards.mdx), which are compare-exchange items that guarantee ACID transactions. - See [Cluster-wide vs. Single-node](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) for a session comparision overview. + See [Cluster-wide vs. Single-node](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) for a session comparision overview. * **Studio** Compare-exchange items can be created from the [Studio](../../../studio/database/documents/compare-exchange-view.mdx#the-compare-exchange-view) as well. @@ -622,7 +622,7 @@ Compare exchange items are created and managed with any of the following approac * **Atomic Guards** When creating documents using a cluster-wide session RavenDB automatically creates [Atomic Guards](../../../client-api/session/cluster-transaction/atomic-guards.mdx), which are compare-exchange items that guarantee ACID transactions. - See [Cluster-wide vs. Single-node](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) for a session comparision overview. + See [Cluster-wide vs. Single-node](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) for a session comparision overview. * **Studio** Compare-exchange items can be created from the [Studio](../../../studio/database/documents/compare-exchange-view.mdx#the-compare-exchange-view) as well. @@ -894,7 +894,7 @@ Compare exchange items are created and managed with any of the following approac * **Atomic Guards** When creating documents using a cluster-wide session RavenDB automatically creates [Atomic Guards](../../../client-api/session/cluster-transaction/atomic-guards.mdx), which are compare-exchange items that guarantee ACID transactions. - See [Cluster-wide vs. Single-node](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) for a session comparision overview. + See [Cluster-wide vs. Single-node](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) for a session comparision overview. * **Studio** Compare-exchange items can be created from the [Studio](../../../studio/database/documents/compare-exchange-view.mdx#the-compare-exchange-view) as well. diff --git a/versioned_docs/version-7.0/client-api/operations/how-to/switch-operations-to-a-different-database.mdx b/versioned_docs/version-7.0/client-api/operations/how-to/switch-operations-to-a-different-database.mdx index 8c04189169..62443644d7 100644 --- a/versioned_docs/version-7.0/client-api/operations/how-to/switch-operations-to-a-different-database.mdx +++ b/versioned_docs/version-7.0/client-api/operations/how-to/switch-operations-to-a-different-database.mdx @@ -27,8 +27,8 @@ export const supportedLanguages = ["csharp", "java", "python", "php", "nodejs"]; If the requested database doesn't exist on the server, an exception will be thrown. * In this page: - * [Common operation: `Operations.ForDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#common-operation:-operations.fordatabase) - * [Maintenance operation: `Maintenance.ForDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#maintenance-operation:-maintenance.fordatabase) + * [Common operation: `Operations.ForDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#common-operation:-operationsfordatabase) + * [Maintenance operation: `Maintenance.ForDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#maintenance-operation:-maintenancefordatabase) ## Common operation: `Operations.ForDatabase` @@ -205,8 +205,8 @@ As with `operations`, by default the `maintenance` operations available directly If the requested database doesn't exist on the server, an exception will be thrown. * In this page: - * [Common operation: `operations.for_database`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#common-operation:-operations.for_database) - * [Maintenance operation: `maintenance.for_database`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#maintenance-operation:-maintenance.for_database) + * [Common operation: `operations.for_database`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#common-operation:-operationsfor_database) + * [Maintenance operation: `maintenance.for_database`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#maintenance-operation:-maintenancefor_database) ## Common operation: `operations.for_database` @@ -301,7 +301,7 @@ with DocumentStore() as document_store: * In this page: * [Common operation: `forDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#common-operation:-fordatabase) - * [Maintenance operation: `maintenance.for_database`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#maintenance-operation:-maintenance.for_database) + * [Maintenance operation: `maintenance.for_database`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#maintenance-operation:-maintenancefor_database) ## Common operation: `forDatabase` @@ -411,8 +411,8 @@ try \{ If the requested database doesn't exist on the server, an exception will be thrown. * In this page: - * [Common operation: `operations.forDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#common-operation:-operations.fordatabase) - * [Maintenance operation: `maintenance.forDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#maintenance-operation:-maintenance.fordatabase) + * [Common operation: `operations.forDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#common-operation:-operationsfordatabase) + * [Maintenance operation: `maintenance.forDatabase`](../../../client-api/operations/how-to/switch-operations-to-a-different-database.mdx#maintenance-operation:-maintenancefordatabase) ## Common operation: `operations.forDatabase` diff --git a/versioned_docs/version-7.0/client-api/operations/maintenance/backup/backup-overview.mdx b/versioned_docs/version-7.0/client-api/operations/maintenance/backup/backup-overview.mdx index f6c7ab02b1..bfb7112f22 100644 --- a/versioned_docs/version-7.0/client-api/operations/maintenance/backup/backup-overview.mdx +++ b/versioned_docs/version-7.0/client-api/operations/maintenance/backup/backup-overview.mdx @@ -208,7 +208,7 @@ IncrementalBackupFrequency = "*/20 * * * *", * RavenDB will store data in a local folder first, and transfer it to the remote destination from the local one. * If a local folder hasn't been specified, RavenDB will use the - temp folder defined in its [Storage.TempPath](../../../../server/configuration/storage-configuration.mdx#storage.temppath) setting. + temp folder defined in its [Storage.TempPath](../../../../server/configuration/storage-configuration.mdx#storagetemppath) setting. If _Storage.TempPath_ is not defined, the temporary files will be created at the same location as the data file. In either case, the folder will be used as temporary storage diff --git a/versioned_docs/version-7.0/client-api/operations/patching/single-document.mdx b/versioned_docs/version-7.0/client-api/operations/patching/single-document.mdx index 8151f447f7..5736133e3b 100644 --- a/versioned_docs/version-7.0/client-api/operations/patching/single-document.mdx +++ b/versioned_docs/version-7.0/client-api/operations/patching/single-document.mdx @@ -1164,7 +1164,7 @@ The method can be called by document ID or by document reference. * When using a JavaScript script with the _defer_ or _operations_ syntax, you can apply logic using **inline string compilation**. -* To enable this, set the [Patching.AllowStringCompilation](../../../server/configuration/patching-configuration.mdx#patching.allowstringcompilation) configuration key to _true_. +* To enable this, set the [Patching.AllowStringCompilation](../../../server/configuration/patching-configuration.mdx#patchingallowstringcompilation) configuration key to _true_. @@ -3292,7 +3292,7 @@ await documentStore.operations.send(patchOp); #### Patching using inline string compilation * When using a JavaScript script with the _defer_ or _operations_ syntax, you can apply logic using **inline string compilation**. -* To enable this, set the [Patching.AllowStringCompilation](../../../server/configuration/patching-configuration.mdx#patching.allowstringcompilation) configuration key to _true_. +* To enable this, set the [Patching.AllowStringCompilation](../../../server/configuration/patching-configuration.mdx#patchingallowstringcompilation) configuration key to _true_. diff --git a/versioned_docs/version-7.0/client-api/session/cluster-transaction/atomic-guards.mdx b/versioned_docs/version-7.0/client-api/session/cluster-transaction/atomic-guards.mdx index a7114527d0..c98e0d24ab 100644 --- a/versioned_docs/version-7.0/client-api/session/cluster-transaction/atomic-guards.mdx +++ b/versioned_docs/version-7.0/client-api/session/cluster-transaction/atomic-guards.mdx @@ -269,7 +269,7 @@ Atomic guards are removed **automatically** in the following scenarios: even if the document is expected to be new. * This is especially important if a document (originally created in a cluster-wide transaction) was deleted **outside** of a cluster-wide session - - as when using a [single-node session](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) + as when using a [single-node session](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) or the [DeleteByQueryOperation](../../../client-api/operations/common/delete-by-query.mdx). In these cases, the document is deleted, but the atomic guard remains (it is not automatically removed). If you attempt to re-create such a document without loading it first, @@ -563,7 +563,7 @@ Atomic guards are removed **automatically** in the following scenarios: even if the document is expected to be a new document. * This is especially important if a document (originally created in a cluster-wide transaction) was deleted **outside** of a cluster-wide session - - e.g., when using a [single-node session](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) + e.g., when using a [single-node session](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) or the [DeleteByQueryOperation](../../../client-api/operations/common/delete-by-query.mdx). In these cases, the document is deleted, but the atomic guard remains (it is not automatically removed). If you attempt to re-create such a document without loading it first, @@ -833,7 +833,7 @@ Atomic guards are removed **automatically** in the following scenarios: even if the document is expected to be a new document. * This is especially important if a document (originally created in a cluster-wide transaction) was deleted **outside** of a cluster-wide session - - e.g., when using a [single-node session](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) + e.g., when using a [single-node session](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) or the [DeleteByQueryOperation](../../../client-api/operations/common/delete-by-query.mdx). In these cases, the document is deleted, but the atomic guard remains (it is not automatically removed). If you attempt to re-create such a document without loading it first, @@ -1094,7 +1094,7 @@ Atomic guards are removed **automatically** in the following scenarios: even if the document is expected to be a new document. * This is especially important if a document (originally created in a cluster-wide transaction) was deleted **outside** of a cluster-wide session - - e.g., when using a [single-node session](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) + e.g., when using a [single-node session](../../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) or the [DeleteByQueryOperation](../../../client-api/operations/common/delete-by-query.mdx). In these cases, the document is deleted, but the atomic guard remains (it is not automatically removed). If you attempt to re-create such a document without loading it first, diff --git a/versioned_docs/version-7.0/client-api/session/cluster-transaction/overview.mdx b/versioned_docs/version-7.0/client-api/session/cluster-transaction/overview.mdx index 58e6bfbfa2..6b0863a4ef 100644 --- a/versioned_docs/version-7.0/client-api/session/cluster-transaction/overview.mdx +++ b/versioned_docs/version-7.0/client-api/session/cluster-transaction/overview.mdx @@ -30,7 +30,7 @@ export const supportedLanguages = ["csharp", "python", "php", "nodejs"]; * 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) + * [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 @@ -145,7 +145,7 @@ For a detailed description of transactions in RavenDB please refer to the [Trans * 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) + * [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 @@ -242,7 +242,7 @@ For a detailed description of transactions in RavenDB please refer to the [Trans * 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) + * [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 @@ -347,7 +347,7 @@ For a detailed description of transactions in RavenDB please refer to the [Trans * 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) + * [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 diff --git a/versioned_docs/version-7.0/client-api/session/opening-a-session.mdx b/versioned_docs/version-7.0/client-api/session/opening-a-session.mdx index 01fd1613e5..0e2dda3ffa 100644 --- a/versioned_docs/version-7.0/client-api/session/opening-a-session.mdx +++ b/versioned_docs/version-7.0/client-api/session/opening-a-session.mdx @@ -92,7 +92,7 @@ IAsyncDocumentSession OpenAsyncSession(SessionOptions options); | **NoTracking** | `bool` | `true` - The Session tracks changes made to all entities it loaded, stored, or queried for.
`false` - Tracking will be turned off.
Learn more in [Disable tracking](../../client-api/session/configuration/how-to-disable-tracking.mdx) | `false` | | **NoCaching** | `bool` | `true` - Server responses will Not be cached.
`false` - The Session caches the server responses.
Learn more in [Disable caching](../../client-api/session/configuration/how-to-disable-caching.mdx) | `false` | | **RequestExecutor** | `RequestExecutor` | ( _Advanced option_ )
The request executor the Session should use. | `null` - the default request executor is used | -| **TransactionMode** | `TransactionMode` | Specify the Session's transaction mode
`SingleNode` / `ClusterWide`
Learn more in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) | `SingleNode` | +| **TransactionMode** | `TransactionMode` | Specify the Session's transaction mode
`SingleNode` / `ClusterWide`
Learn more in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) | `SingleNode` | * Experts Only: @@ -341,7 +341,7 @@ def open_session( | **no_tracking** | `bool` | `True` - The Session tracks changes made to all entities it loaded, stored, or queried for.
`False` - Tracking will be turned off.
Learn more in [Disable tracking](../../client-api/session/configuration/how-to-disable-tracking.mdx) | `False` | | **no_caching** | `bool` | `True` - Server responses will not be cached.
`False` - The Session caches the server responses.
Learn more in [Disable caching](../../client-api/session/configuration/how-to-disable-caching.mdx) | `False` | | **request_executor** | `RequestExecutor` | ( _Advanced option_ )
The request executor the Session should use. | `None` - the default request executor is used | -| **transaction_mode** | `TransactionMode` | Specify the Session's transaction mode
`SINGLE_NODE` / `CLUSTER_WIDE`
Learn more in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) | `SINGLE_NODE` | +| **transaction_mode** | `TransactionMode` | Specify the Session's transaction mode
`SINGLE_NODE` / `CLUSTER_WIDE`
Learn more in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) | `SINGLE_NODE` | * Experts Only: @@ -432,7 +432,7 @@ public function openSession(SessionOptions $sessionOptions): DocumentSessionInte | **NoTracking** | `bool` | `true` - The Session tracks changes made to all entities it loaded, stored, or queried for.
`false` - Tracking will be turned off.
Learn more in [Disable tracking](../../client-api/session/configuration/how-to-disable-tracking.mdx) | `false` | | **NoCaching** | `bool` | `true` - Server responses will Not be cached.
`false` - The Session caches the server responses.
Learn more in [Disable caching](../../client-api/session/configuration/how-to-disable-caching.mdx) | `false` | | **RequestExecutor** | `RequestExecutor` | ( _Advanced option_ )
The request executor the Session should use. | `null` - the default request executor is used | -| **TransactionMode** | `TransactionMode` | Specify the Session's transaction mode
`SingleNode` / `ClusterWide`
Learn more in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) | `SingleNode` | +| **TransactionMode** | `TransactionMode` | Specify the Session's transaction mode
`SingleNode` / `ClusterWide`
Learn more in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) | `SingleNode` | * Experts Only: @@ -573,7 +573,7 @@ openSession(sessionOptions); | **noTracking** | boolean | `true` - The session tracks changes made to all entities it loaded, stored, or queried for.
`false` - Tracking will be turned off.
Learn more in [Disable tracking](../../client-api/session/configuration/how-to-disable-tracking.mdx) | `false` | | **noCaching** | boolean | `true` - Server responses will Not be cached.
`false` - The session caches the server responses.
Learn more in [Disable caching](../../client-api/session/configuration/how-to-disable-caching.mdx) | `false` | | **requestExecutor** | `RequestExecutor` | ( _Advanced option_ )
The request executor the session should use. | `null` - the default request executor is used | -| **transactionMode** | `TransactionMode` | Specify the session's transaction mode
`SingleNode` / `ClusterWide`
Learn more in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) | `SingleNode` | +| **transactionMode** | `TransactionMode` | Specify the session's transaction mode
`SingleNode` / `ClusterWide`
Learn more in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) | `SingleNode` | * Experts Only: diff --git a/versioned_docs/version-7.0/client-api/session/querying/document-query/what-is-document-query.mdx b/versioned_docs/version-7.0/client-api/session/querying/document-query/what-is-document-query.mdx index ff61427c33..cb62f130fb 100644 --- a/versioned_docs/version-7.0/client-api/session/querying/document-query/what-is-document-query.mdx +++ b/versioned_docs/version-7.0/client-api/session/querying/document-query/what-is-document-query.mdx @@ -159,7 +159,7 @@ List products = await asyncSession.Advanced #### Query an index -Please refer to [Querying an index](../../../../indexes/querying/query-index.mdx#session.advanced.documentquery) for examples of querying an index using a DocumentQuery. +Please refer to [Querying an index](../../../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) for examples of querying an index using a DocumentQuery. @@ -674,7 +674,7 @@ products = list(session.advanced.document_query(object_type=Product).skip(5).tak #### Query an index -Please refer to [Querying an index](../../../../indexes/querying/query-index.mdx#session.advanced.documentquery) for examples of querying an index using document_query. +Please refer to [Querying an index](../../../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) for examples of querying an index using document_query. @@ -880,7 +880,7 @@ $employees = $session -Please refer to [Querying an index](../../../../indexes/querying/query-index.mdx#session.advanced.documentquery) for examples of querying an index using a documentQuery. +Please refer to [Querying an index](../../../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) for examples of querying an index using a documentQuery. diff --git a/versioned_docs/version-7.0/client-api/session/querying/how-to-make-a-spatial-query.mdx b/versioned_docs/version-7.0/client-api/session/querying/how-to-make-a-spatial-query.mdx index 6467cf586e..fe91b698f8 100644 --- a/versioned_docs/version-7.0/client-api/session/querying/how-to-make-a-spatial-query.mdx +++ b/versioned_docs/version-7.0/client-api/session/querying/how-to-make-a-spatial-query.mdx @@ -691,7 +691,7 @@ order by spatial.distance( This metadata property is always available in the results. * When using **Corax**: In order to enhance performance, this property is not included in the results by default. - To get this metadata property you must set the [Indexing.Corax.IncludeSpatialDistance](../../../server/configuration/indexing-configuration.mdx#indexing.corax.includespatialdistance) configuration value to _true_. + To get this metadata property you must set the [Indexing.Corax.IncludeSpatialDistance](../../../server/configuration/indexing-configuration.mdx#indexingcoraxincludespatialdistance) configuration value to _true_. Learn about the available methods for setting an indexing configuration key in this [indexing-configuration](../../../server/configuration/indexing-configuration.mdx) article. @@ -1609,7 +1609,7 @@ order by spatial.distance( This metadata property is always available in the results. * When using **Corax**: In order to enhance performance, this property is not included in the results by default. - To get this metadata property you must set the [Indexing.Corax.IncludeSpatialDistance](../../../server/configuration/indexing-configuration.mdx#indexing.corax.includespatialdistance) configuration value to _true_. + To get this metadata property you must set the [Indexing.Corax.IncludeSpatialDistance](../../../server/configuration/indexing-configuration.mdx#indexingcoraxincludespatialdistance) configuration value to _true_. Learn about the available methods for setting an indexing configuration key in this [indexing-configuration](../../../server/configuration/indexing-configuration.mdx) article. @@ -2152,7 +2152,7 @@ order by spatial.distance( * When using __Corax__: In order to enhance performance, this property is not included in the results by default. - To get this metadata property you must set the [Indexing.Corax.IncludeSpatialDistance](../../../server/configuration/indexing-configuration.mdx#indexing.corax.includespatialdistance) configuration value to _true_. + To get this metadata property you must set the [Indexing.Corax.IncludeSpatialDistance](../../../server/configuration/indexing-configuration.mdx#indexingcoraxincludespatialdistance) configuration value to _true_. Learn about the available methods for setting an indexing configuration key in this [indexing-configuration](../../../server/configuration/indexing-configuration.mdx) article. diff --git a/versioned_docs/version-7.0/client-api/session/querying/how-to-project-query-results.mdx b/versioned_docs/version-7.0/client-api/session/querying/how-to-project-query-results.mdx index ddf95312e8..be0353d123 100644 --- a/versioned_docs/version-7.0/client-api/session/querying/how-to-project-query-results.mdx +++ b/versioned_docs/version-7.0/client-api/session/querying/how-to-project-query-results.mdx @@ -92,8 +92,8 @@ export const supportedLanguages = ["csharp", "java", "python", "php", "nodejs"]; * But while calculations within a projection are allowed, having a very complex logic can impact query performance. So RavenDB limits the total time it will spend processing a query and its projections. Exceeding this time limit will fail the query. This is configurable, see the following configuration keys: - * [Databases.QueryTimeoutInSec](../../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec) - * [Databases.QueryOperationTimeoutInSec](../../../server/configuration/database-configuration.mdx#databases.queryoperationtimeoutinsec) + * [Databases.QueryTimeoutInSec](../../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec) + * [Databases.QueryOperationTimeoutInSec](../../../server/configuration/database-configuration.mdx#databasesqueryoperationtimeoutinsec) @@ -1240,8 +1240,8 @@ If the projected fields are stored inside the index itself (`FieldStorage.YES` i * But while calculations within a projection are allowed, having a very complex logic can impact query performance. So RavenDB limits the total time it will spend processing a query and its projections. Exceeding this time limit will fail the query. This is configurable, see the following configuration keys: - * [Databases.QueryTimeoutInSec](../../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec) - * [Databases.QueryOperationTimeoutInSec](../../../server/configuration/database-configuration.mdx#databases.queryoperationtimeoutinsec) + * [Databases.QueryTimeoutInSec](../../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec) + * [Databases.QueryOperationTimeoutInSec](../../../server/configuration/database-configuration.mdx#databasesqueryoperationtimeoutinsec) @@ -1652,8 +1652,8 @@ except Exception as e: * But while calculations within a projection are allowed, having a very complex logic can impact query performance. So RavenDB limits the total time it will spend processing a query and its projections. Exceeding this time limit will fail the query. This is configurable, see the following configuration keys: - * [Databases.QueryTimeoutInSec](../../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec) - * [Databases.QueryOperationTimeoutInSec](../../../server/configuration/database-configuration.mdx#databases.queryoperationtimeoutinsec) + * [Databases.QueryTimeoutInSec](../../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec) + * [Databases.QueryOperationTimeoutInSec](../../../server/configuration/database-configuration.mdx#databasesqueryoperationtimeoutinsec) @@ -2001,8 +2001,8 @@ Attempting multiple projection executions in the same query will result in an ex * But while calculations within a projection are allowed, having a very complex logic can impact query performance. So RavenDB limits the total time it will spend processing a query and its projections. Exceeding this time limit will fail the query. This is configurable, see the following configuration keys: - * [Databases.QueryTimeoutInSec](../../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec) - * [Databases.QueryOperationTimeoutInSec](../../../server/configuration/database-configuration.mdx#databases.queryoperationtimeoutinsec) + * [Databases.QueryTimeoutInSec](../../../server/configuration/database-configuration.mdx#databasesquerytimeoutinsec) + * [Databases.QueryOperationTimeoutInSec](../../../server/configuration/database-configuration.mdx#databasesqueryoperationtimeoutinsec) diff --git a/versioned_docs/version-7.0/client-api/session/querying/how-to-query.mdx b/versioned_docs/version-7.0/client-api/session/querying/how-to-query.mdx index 72e1c5c278..18b893700f 100644 --- a/versioned_docs/version-7.0/client-api/session/querying/how-to-query.mdx +++ b/versioned_docs/version-7.0/client-api/session/querying/how-to-query.mdx @@ -43,12 +43,12 @@ export const supportedLanguages = ["csharp", "python", "php", "nodejs"]; * Query results are **cached** by default. To disable query caching see [NoCaching](../../../client-api/session/querying/how-to-customize-query.mdx#nocaching). -* Queries are timed out after a configurable time period. See [query timeout](../../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec). +* 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#session.query) - * [Session.Advanced.DocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery) - * [Session.Advanced.RawQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) + * [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) @@ -123,7 +123,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#session.query). + See more examples [below](../../../client-api/session/querying/how-to-query.mdx#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). @@ -155,7 +155,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#session.query). + See more examples [below](../../../client-api/session/querying/how-to-query.mdx#sessionquery). @@ -556,7 +556,7 @@ from "Employees" where FirstName = "Robert" ## Session.Advanced.RawQuery -* Queries defined with [Query](../../../client-api/session/querying/how-to-query.mdx#session.query) or [DocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery) are translated by the RavenDB client to [RQL](../../../client-api/session/querying/what-is-rql.mdx) +* 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) when sent to the server. * The session also gives you a way to express the query directly in RQL using the `RawQuery` method. @@ -604,7 +604,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#session.query) method: +* Available custom methods and extensions for the session's [Query](../../../client-api/session/querying/how-to-query.mdx#sessionquery) method: * [AggregateBy](../../../client-api/session/querying/how-to-perform-a-faceted-search.mdx) * AnyAsync @@ -711,12 +711,12 @@ IRawDocumentQuery RawQuery(string query); * Query results are **cached** by default. To disable query caching see [NoCaching](../../../client-api/session/querying/how-to-customize-query.mdx#nocaching). -* Queries are timed out after a configurable time period. See [query timeout](../../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec). +* 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#session.query) - * [session.advanced.document_query](../../../client-api/session/querying/how-to-query.mdx#session.advanced.document_query) - * [session.advanced.raw_query](../../../client-api/session/querying/how-to-query.mdx#session.advanced.raw_query) + * [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) @@ -791,7 +791,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#session.query). + See more examples [below](../../../client-api/session/querying/how-to-query.mdx#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). @@ -823,7 +823,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#session.query). + See more examples [below](../../../client-api/session/querying/how-to-query.mdx#sessionquery). @@ -1076,7 +1076,7 @@ from "Employees" where FirstName = "Robert" ## session.advanced.raw_query -* Queries defined with [query](../../../client-api/session/querying/how-to-query.mdx#session.query) or [document_query](../../../client-api/session/querying/how-to-query.mdx#session.advanced.document_query) are translated by the RavenDB client to [RQL](../../../client-api/session/querying/what-is-rql.mdx) +* 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) when sent to the server. * The session also gives you a way to express the query directly in RQL using the `raw_query` method. @@ -1106,7 +1106,7 @@ employees = list( # Execute the query ## Custom methods -Available custom methods for session's [query](../../../client-api/session/querying/how-to-query.mdx#session.query) method: +Available custom methods for session's [query](../../../client-api/session/querying/how-to-query.mdx#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) @@ -1226,12 +1226,12 @@ def raw_query(self, query: str, object_type: Optional[Type[_T]] = None) -> RawDo To disable query caching see [NoCaching](../../../client-api/session/querying/how-to-customize-query.mdx#nocaching). * Queries are timed out after a configurable time period. - See [query timeout](../../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec). + 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#session.query) - * [session.advanced.documentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery) - * [session.advanced.rawQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) + * [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) @@ -1306,7 +1306,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#session.query). + See more examples [below](../../../client-api/session/querying/how-to-query.mdx#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) @@ -1339,7 +1339,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#session.query). + See more examples [below](../../../client-api/session/querying/how-to-query.mdx#sessionquery). @@ -1536,8 +1536,8 @@ from "Employees" where FirstName = "Robert" ## session.advanced.rawQuery -* Queries defined with [query](../../../client-api/session/querying/how-to-query.mdx#session.query) - or [documentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery) +* 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) when sent to the server. @@ -1567,7 +1567,7 @@ $employees = $session ## Custom methods -Available custom methods for session's [query](../../../client-api/session/querying/how-to-query.mdx#session.query) method: +Available custom methods for session's [query](../../../client-api/session/querying/how-to-query.mdx#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) @@ -1651,11 +1651,11 @@ public function rawQuery(?string $className, string $query): RawDocumentQueryInt * Query results are **cached** by default. To disable query caching see [noCaching](../../../client-api/session/querying/how-to-customize-query.mdx#nocaching). -* Queries are timed out after a configurable time period. See [query timeout](../../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec). +* 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#session.query) - * [session.advanced.rawQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) + * [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) @@ -1730,7 +1730,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#session.query). + See more examples [below](../../../client-api/session/querying/how-to-query.mdx#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). @@ -1762,7 +1762,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#session.query). + See more examples [below](../../../client-api/session/querying/how-to-query.mdx#sessionquery). @@ -1967,7 +1967,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#session.query) 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](../../../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. * The session also gives you a way to express the query directly in RQL using the `rawQuery` method. @@ -1995,7 +1995,7 @@ const employees = await session.advanced ## query API -Available methods for the session's [query](../../../client-api/session/querying/how-to-query.mdx#session.query) method: +Available methods for the session's [query](../../../client-api/session/querying/how-to-query.mdx#sessionquery) method: - addOrder - addParameter diff --git a/versioned_docs/version-7.0/client-api/session/querying/how-to-stream-query-results.mdx b/versioned_docs/version-7.0/client-api/session/querying/how-to-stream-query-results.mdx index 174dcc7782..b34c2ec3ad 100644 --- a/versioned_docs/version-7.0/client-api/session/querying/how-to-stream-query-results.mdx +++ b/versioned_docs/version-7.0/client-api/session/querying/how-to-stream-query-results.mdx @@ -527,7 +527,7 @@ IEnumerator> Stream(IRawDocumentQuery query, out StreamQue | Parameters | type | description | | - | - | - | -| **query** | [IQueryable](../../../client-api/session/querying/how-to-query.mdx#session.query), [IDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery) or [IRawDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) | The query for which to stream results | +| **query** | [IQueryable](../../../client-api/session/querying/how-to-query.mdx#sessionquery), [IDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery) or [IRawDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) | The query for which to stream results | | `out` **streamQueryStats** | [StreamQueryStatistics](../../../glossary/stream-query-statistics.mdx) | Information about performed query | | Return Value | | @@ -671,7 +671,7 @@ To stream results, use the `stream` method from the `advanced` session operation | Parameters | | | | ------------- | ------------- | ----- | -| **query** | [IDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery) or [IRawDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) | Query to stream results for. | +| **query** | [IDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery) or [IRawDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) | Query to stream results for. | | `Reference` **streamQueryStats** | StreamQueryStatistics | Information about performed query. | | Return Value | | diff --git a/versioned_docs/version-7.0/client-api/session/querying/sort-query-results.mdx b/versioned_docs/version-7.0/client-api/session/querying/sort-query-results.mdx index 03dedd3524..5b208e9399 100644 --- a/versioned_docs/version-7.0/client-api/session/querying/sort-query-results.mdx +++ b/versioned_docs/version-7.0/client-api/session/querying/sort-query-results.mdx @@ -226,7 +226,7 @@ The score details can be retrieved by either: * When using __Corax__: In order to enhance performance, this metadata property is Not included in the results by default. - To get this metadata property you must set the [Indexing.Corax.IncludeDocumentScore](../../../server/configuration/indexing-configuration.mdx#indexing.corax.includedocumentscore) configuration value to _true_. + To get this metadata property you must set the [Indexing.Corax.IncludeDocumentScore](../../../server/configuration/indexing-configuration.mdx#indexingcoraxincludedocumentscore) configuration value to _true_. Learn about the available methods for setting an indexing configuration key in this [indexing-configuration](../../../server/configuration/indexing-configuration.mdx) article. * The following example shows how to get the score from the metadata of the resulting entities that were loaded to the session: @@ -924,7 +924,7 @@ The score details can be retrieved by either: * When using **Corax**: In order to enhance performance, this metadata property is Not included in the results by default. - To get this metadata property you must set the [Indexing.Corax.IncludeDocumentScore](../../../server/configuration/indexing-configuration.mdx#indexing.corax.includedocumentscore) configuration value to `True` + To get this metadata property you must set the [Indexing.Corax.IncludeDocumentScore](../../../server/configuration/indexing-configuration.mdx#indexingcoraxincludedocumentscore) configuration value to `True` Learn about the available methods for setting an indexing configuration key in this [indexing-configuration](../../../server/configuration/indexing-configuration.mdx) article. @@ -1938,7 +1938,7 @@ The score details can be retrieved by either: * When using __Corax__: In order to enhance performance, this metadata property is Not included in the results by default. - To get this metadata property you must set the [Indexing.Corax.IncludeDocumentScore](../../../server/configuration/indexing-configuration.mdx#indexing.corax.includedocumentscore) configuration value to _true_. + To get this metadata property you must set the [Indexing.Corax.IncludeDocumentScore](../../../server/configuration/indexing-configuration.mdx#indexingcoraxincludedocumentscore) configuration value to _true_. Learn about the available methods for setting an indexing configuration key in this [indexing-configuration](../../../server/configuration/indexing-configuration.mdx) article. * The following example shows how to get the score from the metadata of the resulting entities that were loaded to the session: diff --git a/versioned_docs/version-7.0/client-api/session/updating-entities.mdx b/versioned_docs/version-7.0/client-api/session/updating-entities.mdx index 832848001b..0eaacff91d 100644 --- a/versioned_docs/version-7.0/client-api/session/updating-entities.mdx +++ b/versioned_docs/version-7.0/client-api/session/updating-entities.mdx @@ -23,7 +23,7 @@ export const supportedLanguages = ["csharp", "python", "php", "nodejs"]; * To modify existing documents: - * **Retrieve** documents from the database using [Load](../../client-api/session/loading-entities.mdx#load) or by a [Query](../../client-api/session/querying/how-to-query.mdx#session.query). + * **Retrieve** documents from the database using [Load](../../client-api/session/loading-entities.mdx#load) or by a [Query](../../client-api/session/querying/how-to-query.mdx#sessionquery). The entities loaded from the documents are added to the internal entities map that the Session manages. * **Edit** the properties you wish to change. @@ -146,7 +146,7 @@ export const supportedLanguages = ["csharp", "python", "php", "nodejs"]; * To modify existing documents: - * **Retrieve** documents from the database using [load](../../client-api/session/loading-entities.mdx#load) or by a [query](../../client-api/session/querying/how-to-query.mdx#session.query). + * **Retrieve** documents from the database using [load](../../client-api/session/loading-entities.mdx#load) or by a [query](../../client-api/session/querying/how-to-query.mdx#sessionquery). The entities loaded from the documents are added to the internal entities map that the Session manages. * **Edit** the properties you wish to change. @@ -224,7 +224,7 @@ export const supportedLanguages = ["csharp", "python", "php", "nodejs"]; * To modify existing documents: * **Retrieve** documents from the database using [load](../../client-api/session/loading-entities.mdx#load) - or by a [query](../../client-api/session/querying/how-to-query.mdx#session.query). + or by a [query](../../client-api/session/querying/how-to-query.mdx#sessionquery). The entities loaded from the documents are added to the internal entities map that the session manages. * **Edit** the properties you wish to change. @@ -311,7 +311,7 @@ try \{ * To modify existing documents: - * **Retrieve** documents from the database using [load](../../client-api/session/loading-entities.mdx#load) or by a [query](../../client-api/session/querying/how-to-query.mdx#session.query). + * **Retrieve** documents from the database using [load](../../client-api/session/loading-entities.mdx#load) or by a [query](../../client-api/session/querying/how-to-query.mdx#sessionquery). The entities loaded from the documents are added to the internal entities map that the Session manages. * **Edit** the properties you wish to change. diff --git a/versioned_docs/version-7.0/client-api/session/what-is-a-session-and-how-does-it-work.mdx b/versioned_docs/version-7.0/client-api/session/what-is-a-session-and-how-does-it-work.mdx index 9013217f0b..3455205580 100644 --- a/versioned_docs/version-7.0/client-api/session/what-is-a-session-and-how-does-it-work.mdx +++ b/versioned_docs/version-7.0/client-api/session/what-is-a-session-and-how-does-it-work.mdx @@ -282,7 +282,7 @@ Assert.Same(entity1, entity2); The phrase "session's transaction mode" refers to the type of transaction that will be executed on the server-side when `SaveChanges()` is called. As mentioned earlier, the session itself does not represent an ACID transaction. - * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) transactions. + * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) transactions. @@ -571,7 +571,7 @@ Assert.assertSame(entity1, entity2); The phrase "session's transaction mode" refers to the type of transaction that will be executed on the server-side when `saveChanges()` is called. As mentioned earlier, the session itself does not represent an ACID transaction. - * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) transactions. + * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) transactions. @@ -855,7 +855,7 @@ self.assertEqual(entity1, entity2) The phrase "session's transaction mode" refers to the type of transaction that will be executed on the server-side when `save_changes()` is called. As mentioned earlier, the session itself does not represent an ACID transaction. - * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) transactions. + * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) transactions. @@ -1149,7 +1149,7 @@ $this->assertSame($entity1, $entity2); The phrase "session's transaction mode" refers to the type of transaction that will be executed on the server-side when `saveChanges()` is called. As mentioned earlier, the session itself does not represent an ACID transaction. - * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) transactions. + * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) transactions. @@ -1497,7 +1497,7 @@ assert.equal(entity1, entity2); The phrase "session's transaction mode" refers to the type of transaction that will be executed on the server-side when `saveChanges()` is called. As mentioned earlier, the session itself does not represent an ACID transaction. - * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs.-single-node-transaction) transactions. + * Learn more about these modes in [Cluster-wide vs. Single-node](../../client-api/session/cluster-transaction/overview.mdx#cluster-wide-transaction-vs-single-node-transaction) transactions. diff --git a/versioned_docs/version-7.0/data-archival/archived-documents-and-other-features.mdx b/versioned_docs/version-7.0/data-archival/archived-documents-and-other-features.mdx index 34afd8aa99..0a2929913c 100644 --- a/versioned_docs/version-7.0/data-archival/archived-documents-and-other-features.mdx +++ b/versioned_docs/version-7.0/data-archival/archived-documents-and-other-features.mdx @@ -58,7 +58,7 @@ export const supportedLanguages = ["csharp"]; * **Configuring indexing behavior - Static indexes**: * **At the database level or server-wide**: To control whether static indexes process archived documents from the source collection, - set the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.static.archiveddataprocessingbehavior) + set the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingstaticarchiveddataprocessingbehavior) configuration key at either the database level or server-wide (default: `ExcludeArchived`). * Note that this setting applies only to static-indexes that are using _Documents_ as their data source. This global configuration does Not apply to static-indexes based on _Time Series_ or _Counters_, which default to `IncludeArchived`. @@ -69,7 +69,7 @@ export const supportedLanguages = ["csharp"]; * **Configuring indexing behavior - Auto indexes:** * **At the database level or server-wide**: To control whether auto-indexes process archived documents at the database level or server-wide, - set the [Indexing.Auto.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.auto.archiveddataprocessingbehavior) configuration key (default `ExcludeArchived`). + set the [Indexing.Auto.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingautoarchiveddataprocessingbehavior) configuration key (default `ExcludeArchived`). * **Per index**: Unlike static indexes, you cannot configure this behavior per auto-index, because dynamic queries (which trigger auto-index creation) do not provide a way to control this setting. @@ -80,7 +80,7 @@ export const supportedLanguages = ["csharp"]; ##### Configuring archived document processing for a static index - from the Client API You can configure how a static index handles archived documents when creating the index using the Client API. -This setting will **override** the global configuration defined by the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.static.archiveddataprocessingbehavior) configuration key. +This setting will **override** the global configuration defined by the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingstaticarchiveddataprocessingbehavior) configuration key. @@ -280,7 +280,7 @@ store.Maintenance.Send(new PutIndexesOperation(indexDefinition)); ##### Configuring archived document processing for a static index - from the Studio You can configure how a static index handles archived documents directly from the Studio. -This setting will **override** the global configuration defined by the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.static.archiveddataprocessingbehavior) configuration key. +This setting will **override** the global configuration defined by the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingstaticarchiveddataprocessingbehavior) configuration key. ![Configure index](./assets/configure-static-index.png) @@ -306,7 +306,7 @@ This setting will **override** the global configuration defined by the [Indexing * **Dynamic queries (auto-indexes)**: * When making a dynamic query, RavenDB creates an auto-index to serve it. - Whether that index processes archived documents depends on the value of the [Indexing.Auto.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.auto.archiveddataprocessingbehavior) configuration key at the time the query is made. + Whether that index processes archived documents depends on the value of the [Indexing.Auto.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingautoarchiveddataprocessingbehavior) configuration key at the time the query is made. * Once created, the auto-index retains that behavior. Query results will continue to reflect the configuration that was in effect when the index was first built - even if the setting is changed later. * Learn more about dynamic queries in [Query a collection - with filtering](../client-api/session/querying/how-to-query.mdx#dynamicQuery). @@ -314,7 +314,7 @@ This setting will **override** the global configuration defined by the [Indexing * **Querying static-indexes**: * When querying a static-index, the results will include, exclude, or consist solely of archived documents depending on how the static-index was configured. The index behavior is determined by: - * the value of the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.static.archiveddataprocessingbehavior) configuration key at the time the static-index was created, or - + * the value of the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingstaticarchiveddataprocessingbehavior) configuration key at the time the static-index was created, or - * the explicit setting in the index definition, which overrides the global configuration key. * The index's archived data processing behavior can be modified after its creation using the Studio or the Client API. @@ -340,7 +340,7 @@ This setting will **override** the global configuration defined by the [Indexing ##### Configuring archived document processing for a data subscription task - from the Client API You can configure how a subscription task handles archived documents when creating the subscription using the Client API. -This setting will **override** the global configuration defined by the [Subscriptions.ArchivedDataProcessingBehavior](../server/configuration/subscription-configuration.mdx#subscriptions.archiveddataprocessingbehavior) configuration key. +This setting will **override** the global configuration defined by the [Subscriptions.ArchivedDataProcessingBehavior](../server/configuration/subscription-configuration.mdx#subscriptionsarchiveddataprocessingbehavior) configuration key. @@ -384,7 +384,7 @@ Example: ##### Configuring archived document processing for a data subscription task - from the Studio You can configure how a subscription task handles archived documents directly from the Studio. -This setting will **override** the global configuration defined by the [Subscriptions.ArchivedDataProcessingBehavior](../server/configuration/subscription-configuration.mdx#subscriptions.archiveddataprocessingbehavior) configuration key. +This setting will **override** the global configuration defined by the [Subscriptions.ArchivedDataProcessingBehavior](../server/configuration/subscription-configuration.mdx#subscriptionsarchiveddataprocessingbehavior) configuration key. ![Configure subscription](./assets/configure-subscription.png) diff --git a/versioned_docs/version-7.0/data-archival/unarchiving-documents.mdx b/versioned_docs/version-7.0/data-archival/unarchiving-documents.mdx index a5e894a9ec..4dbced57b9 100644 --- a/versioned_docs/version-7.0/data-archival/unarchiving-documents.mdx +++ b/versioned_docs/version-7.0/data-archival/unarchiving-documents.mdx @@ -180,7 +180,7 @@ It will unarchive all archived documents in the _Orders_ collection. As a result, no documents will be unarchived by the patch operation. * For example, the following patch query uses a dynamic query that creates an auto-index. - If the [Indexing.Auto.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.auto.archiveddataprocessingbehavior) configuration key is set to its default `ExcludeArchived` value, + If the [Indexing.Auto.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingautoarchiveddataprocessingbehavior) configuration key is set to its default `ExcludeArchived` value, then even if archived documents exist in the _Orders_ collection with `ShipTo.Country == 'USA'`, they will not be matched - because the auto-index does not include them - and the patch operation will not unarchive any documents. @@ -208,9 +208,9 @@ Two possible workarounds are: Use this option only if including archived documents in the index aligns with your indexing strategy. **For auto-indexes**: - Set the [Indexing.Auto.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.auto.archiveddataprocessingbehavior) configuration key to `IncludeArchived`. + Set the [Indexing.Auto.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingautoarchiveddataprocessingbehavior) configuration key to `IncludeArchived`. **For static-indexes**: - Set the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexing.static.archiveddataprocessingbehavior) configuration key to `IncludeArchived`, + Set the [Indexing.Static.ArchivedDataProcessingBehavior](../server/configuration/indexing-configuration.mdx#indexingstaticarchiveddataprocessingbehavior) configuration key to `IncludeArchived`, or - configure the definition of the specific static-index to include archived documents. See [Archived documents and indexing](../data-archival/archived-documents-and-other-features.mdx#archived-documents-and-indexing). diff --git a/versioned_docs/version-7.0/document-extensions/counters/counters-and-other-features.mdx b/versioned_docs/version-7.0/document-extensions/counters/counters-and-other-features.mdx index 0366377069..d04c16f05e 100644 --- a/versioned_docs/version-7.0/document-extensions/counters/counters-and-other-features.mdx +++ b/versioned_docs/version-7.0/document-extensions/counters/counters-and-other-features.mdx @@ -58,7 +58,7 @@ Create queries **using code**, or send the server **raw queries** for execution. * 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. -* Use [Session.Query](../../client-api/session/querying/how-to-query.mdx#session.query) to code queries yourself. +* Use [Session.Query](../../client-api/session/querying/how-to-query.mdx#sessionquery) to code queries yourself. * **Returned Counter Value**: **Accumulated** A Counter's value is returned as a single sum, with no specification of the Counter's value on each node. @@ -83,7 +83,7 @@ Create queries **using code**, or send the server **raw queries** for execution. -* Use [RawQuery](../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) to send the server raw RQL expressions for execution. +* Use [RawQuery](../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) to send the server raw RQL expressions for execution. * You can use the `counter` method. **Returned Counter Value**: **Accumulated** @@ -750,7 +750,7 @@ Create queries **using code**, or send the server **raw queries** for execution. * 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. -* Use [session.query](../../client-api/session/querying/how-to-query.mdx#session.query) to code queries yourself. +* Use [session.query](../../client-api/session/querying/how-to-query.mdx#sessionquery) to code queries yourself. * **Returned Counter Value**: **Accumulated** A Counter's value is returned as a single sum, with no specification of the Counter's value on each node. @@ -762,7 +762,7 @@ Create queries **using code**, or send the server **raw queries** for execution. -* Use [RawQuery](../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) to send the server raw RQL expressions for execution. +* Use [RawQuery](../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) to send the server raw RQL expressions for execution. * You can use the `counter` method. **Returned Counter Value**: **Accumulated** @@ -1051,7 +1051,7 @@ Send the server **raw queries** for execution. * 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. -* Use [RawQuery](../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) to send the server raw RQL expressions for execution. +* Use [RawQuery](../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) to send the server raw RQL expressions for execution. * You can use the `counter` method. **Returned Counter Value**: **Accumulated** @@ -1283,7 +1283,7 @@ Create queries **using code**, or send the server **raw queries** for execution. * 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. -* Use [Session.Query](../../client-api/session/querying/how-to-query.mdx#session.query) to code queries yourself. +* Use [Session.Query](../../client-api/session/querying/how-to-query.mdx#sessionquery) to code queries yourself. * **Returned Counter Value**: **Accumulated** A Counter's value is returned as a single sum, with no specification of the Counter's value on each node. @@ -1300,7 +1300,7 @@ for (let counterValue in queryResults) \{ -* Use [RawQuery](../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) to send the server raw RQL expressions for execution. +* Use [RawQuery](../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) to send the server raw RQL expressions for execution. * You can use the `counter` method. **Returned Counter Value**: **Accumulated** diff --git a/versioned_docs/version-7.0/document-extensions/revisions/client-api/overview.mdx b/versioned_docs/version-7.0/document-extensions/revisions/client-api/overview.mdx index 9689589e8e..1faa78fdb3 100644 --- a/versioned_docs/version-7.0/document-extensions/revisions/client-api/overview.mdx +++ b/versioned_docs/version-7.0/document-extensions/revisions/client-api/overview.mdx @@ -49,7 +49,7 @@ export const supportedLanguages = ["csharp", "java", "python", "php", "nodejs"]; * **Include revisions**: * [IncludeRevisions](../../../document-extensions/revisions/client-api/session/including.mdx#section) - include revisions when retrieving documents via `Session.Load` or `Session.Query`. - * [RawQuery](../../../document-extensions/revisions/client-api/session/including.mdx#including-revisions-with-session.advanced.rawquery) - Learn how to include revisions when retrieving documents via raw queries. + * [RawQuery](../../../document-extensions/revisions/client-api/session/including.mdx#including-revisions-with-sessionadvancedrawquery) - Learn how to include revisions when retrieving documents via raw queries. * **Count revisions**: * [GetCountFor](../../../document-extensions/revisions/client-api/session/counting.mdx#getcountfor) - get the number of revisions kept for a document. @@ -103,7 +103,7 @@ export const supportedLanguages = ["csharp", "java", "python", "php", "nodejs"]; * [Including revisions](../../../document-extensions/revisions/client-api/session/including.mdx) * [IncludeRevisions](../../../document-extensions/revisions/client-api/session/including.mdx#section) Use this method to include document revisions when retrieving documents via `Session.Load` or `Session.Query`. - * [RawQuery](../../../document-extensions/revisions/client-api/session/including.mdx#including-revisions-with-session.advanced.rawquery) + * [RawQuery](../../../document-extensions/revisions/client-api/session/including.mdx#including-revisions-with-sessionadvancedrawquery) Learn here how to include revisions with documents retrieved via raw queries. @@ -232,7 +232,7 @@ about creating a revision even if revision configuration is disabled. * **Include revisions**: * [includeRevisions](../../../document-extensions/revisions/client-api/session/including.mdx#section) - include revisions when retrieving documents via `session.load` or `session.query`. - * [rawQuery](../../../document-extensions/revisions/client-api/session/including.mdx#including-revisions-with-session.advanced.rawquery) - Learn how to include revisions when retrieving documents via raw queries. + * [rawQuery](../../../document-extensions/revisions/client-api/session/including.mdx#including-revisions-with-sessionadvancedrawquery) - Learn how to include revisions when retrieving documents via raw queries. * **Count revisions**: * [getCountFor](../../../document-extensions/revisions/client-api/session/counting.mdx#getcountfor) - get the number of revisions kept for a document. diff --git a/versioned_docs/version-7.0/document-extensions/revisions/overview.mdx b/versioned_docs/version-7.0/document-extensions/revisions/overview.mdx index dfde708556..6561a85f3a 100644 --- a/versioned_docs/version-7.0/document-extensions/revisions/overview.mdx +++ b/versioned_docs/version-7.0/document-extensions/revisions/overview.mdx @@ -212,7 +212,7 @@ using the same blittable JSON document format as regular documents. ##### Revisions Compression * By default, revisions are compressed. - This setting can be customized server-wide via the [CompressRevisionsDefault](../../server/configuration/database-configuration.mdx#databases.compression.compressrevisionsdefault) configuration key. + This setting can be customized server-wide via the [CompressRevisionsDefault](../../server/configuration/database-configuration.mdx#databasescompressioncompressrevisionsdefault) configuration key. * At the database level, revisions compression can be customized via the database record, as shown in [this example](../../server/storage/documents-compression.mdx#set-compression-for-selected-collections). * Individual fields are compressed as they are compressed in regular documents: @@ -537,7 +537,7 @@ using the same blittable JSON document format as regular documents. ##### Revisions Compression * By default, revisions are compressed. - This setting can be customized server-wide via the [CompressRevisionsDefault](../../server/configuration/database-configuration.mdx#databases.compression.compressrevisionsdefault) configuration key. + This setting can be customized server-wide via the [CompressRevisionsDefault](../../server/configuration/database-configuration.mdx#databasescompressioncompressrevisionsdefault) configuration key. * At the database level, revisions compression can be customized via the database record, as shown in [this example](../../server/storage/documents-compression.mdx#set-compression-for-selected-collections). * Individual fields are compressed as they are compressed in regular documents: @@ -561,7 +561,7 @@ Read [here](../../document-extensions/revisions/revisions-and-other-features.mdx * **Revisions compression** * Revisions are compressed by default. - Learn [here](../../server/configuration/database-configuration.mdx#databases.compression.compressrevisionsdefault) + Learn [here](../../server/configuration/database-configuration.mdx#databasescompressioncompressrevisionsdefault) how to toggle this database option on and off. * Learn [here](../../server/storage/documents-compression.mdx) how to apply Document Compression to revisions. * Individual fields are compressed as they are compressed in regular documents: @@ -822,7 +822,7 @@ using the same blittable JSON document format as regular documents. ##### Revisions Compression * By default, revisions are compressed. - This setting can be customized server-wide via the [CompressRevisionsDefault](../../server/configuration/database-configuration.mdx#databases.compression.compressrevisionsdefault) configuration key. + This setting can be customized server-wide via the [CompressRevisionsDefault](../../server/configuration/database-configuration.mdx#databasescompressioncompressrevisionsdefault) configuration key. * At the database level, revisions compression can be customized via the database record, as shown in [this example](../../server/storage/documents-compression.mdx#set-compression-for-selected-collections). * Individual fields are compressed as they are compressed in regular documents: diff --git a/versioned_docs/version-7.0/document-extensions/timeseries/client-api/session/include/with-raw-queries.mdx b/versioned_docs/version-7.0/document-extensions/timeseries/client-api/session/include/with-raw-queries.mdx index a5671a523a..9e253dbd96 100644 --- a/versioned_docs/version-7.0/document-extensions/timeseries/client-api/session/include/with-raw-queries.mdx +++ b/versioned_docs/version-7.0/document-extensions/timeseries/client-api/session/include/with-raw-queries.mdx @@ -22,7 +22,7 @@ export const supportedLanguages = ["csharp", "nodejs"]; * Use `include timeseries` in your RQL expression in order to include time series data when making - a raw query via [session.Advanced.RawQuery](../../../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery). + a raw query via [session.Advanced.RawQuery](../../../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery). * The included time series data is stored within the session and can be provided instantly when requested without any additional server calls. @@ -94,7 +94,7 @@ and _include_ entries from the document's "HeartRates" time series. * Use `include timeseries` in your RQL expression in order to include time series data when making - a raw query via [session.advanced.rawQuery](../../../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery). + a raw query via [session.advanced.rawQuery](../../../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery). * The included time series data is stored within the session and can be provided instantly when requested without any additional server calls. diff --git a/versioned_docs/version-7.0/document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx b/versioned_docs/version-7.0/document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx index b7569b7e18..877cbad54f 100644 --- a/versioned_docs/version-7.0/document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx +++ b/versioned_docs/version-7.0/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#timeseries.increment) +* You can use the Javascript [timeseries.increment](../../../../document-extensions/timeseries/incremental-time-series/client-api/javascript-support.mdx#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). @@ -34,7 +34,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * 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#timeseries.increment) + * [`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) @@ -112,7 +112,7 @@ void Increment(double value); ## Usage Sample In this sample we use -[session.Advanced.Defer](../../../../document-extensions/timeseries/client-api/session/patch.mdx#patching-using-session.advanced.defer) +[session.Advanced.Defer](../../../../document-extensions/timeseries/client-api/session/patch.mdx#patching-using-sessionadvanceddefer) to patch an incremental time series. We go through a series of collected stock prices, and add a **2** factor to each collected stock price, that has been originally miscalculated. diff --git a/versioned_docs/version-7.0/document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx b/versioned_docs/version-7.0/document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx index efede0c0b7..a9ed8a6c16 100644 --- a/versioned_docs/version-7.0/document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx +++ b/versioned_docs/version-7.0/document-extensions/timeseries/incremental-time-series/client-api/session/delete.mdx @@ -20,7 +20,7 @@ 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#incrementaltimeseriesfor.delete) + * [`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) diff --git a/versioned_docs/version-7.0/document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx b/versioned_docs/version-7.0/document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx index 432948cff9..5ce3b581be 100644 --- a/versioned_docs/version-7.0/document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx +++ b/versioned_docs/version-7.0/document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx @@ -30,7 +30,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [`IncrementalTimeSeriesFor.Get`](../../../../../document-extensions/timeseries/incremental-time-series/client-api/session/get.mdx#incrementaltimeseriesfor.get) + * [`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) * [Code Samples](../../../../../document-extensions/timeseries/client-api/session/get/get-entries.mdx#code-samples) diff --git a/versioned_docs/version-7.0/document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx b/versioned_docs/version-7.0/document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx index 507e3a5138..65b9b75455 100644 --- a/versioned_docs/version-7.0/document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx +++ b/versioned_docs/version-7.0/document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx @@ -26,7 +26,7 @@ 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#timeseriesfor.append) + * [`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) diff --git a/versioned_docs/version-7.0/document-extensions/timeseries/incremental-time-series/overview.mdx b/versioned_docs/version-7.0/document-extensions/timeseries/incremental-time-series/overview.mdx index e52ae48c0a..30cb6c0df0 100644 --- a/versioned_docs/version-7.0/document-extensions/timeseries/incremental-time-series/overview.mdx +++ b/versioned_docs/version-7.0/document-extensions/timeseries/incremental-time-series/overview.mdx @@ -123,7 +123,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Incremental: Rollup policies can be created as above. However, the resulting rollup time series is non incremental. - It can be handled via [TimeSeriesFor](../../../document-extensions/timeseries/client-api/session/append.mdx#timeseriesfor.append), not + It can be handled via [TimeSeriesFor](../../../document-extensions/timeseries/client-api/session/append.mdx#timeseriesforappend), not [IncrementalTimeSeriesFor](../../../document-extensions/timeseries/incremental-time-series/client-api/session/overview.mdx#methods), and its values can no longer be [Incremented](../../../document-extensions/timeseries/incremental-time-series/client-api/session/increment.mdx). diff --git a/versioned_docs/version-7.0/document-extensions/timeseries/querying/stream-timeseries.mdx b/versioned_docs/version-7.0/document-extensions/timeseries/querying/stream-timeseries.mdx index b0950da419..8c70274601 100644 --- a/versioned_docs/version-7.0/document-extensions/timeseries/querying/stream-timeseries.mdx +++ b/versioned_docs/version-7.0/document-extensions/timeseries/querying/stream-timeseries.mdx @@ -85,7 +85,7 @@ IEnumerator> Stream( | Parameters | Type | Description | | - | - | - | -| **query** | [IQueryable](../../../client-api/session/querying/how-to-query.mdx#session.query), [IDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery) or [IRawDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) | Query to stream results for. | +| **query** | [IQueryable](../../../client-api/session/querying/how-to-query.mdx#sessionquery), [IDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery) or [IRawDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) | Query to stream results for. | | **streamQueryStats** | `out` [StreamQueryStatistics](../../../glossary/stream-query-statistics.mdx) | Information about performed query. | | Return Value | Description | @@ -243,7 +243,7 @@ found [here](../../../client-api/session/querying/how-to-stream-query-results.md | Parameters | | | | ------------- | ------------- | ----- | -| **query** | [IDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery) or [IRawDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) | Query to stream results for. | +| **query** | [IDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery) or [IRawDocumentQuery](../../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) | Query to stream results for. | | `Reference` **streamQueryStats** | StreamQueryStatistics | Information about performed query. | | Return Value | | diff --git a/versioned_docs/version-7.0/indexes/boosting.mdx b/versioned_docs/version-7.0/indexes/boosting.mdx index e48c76efcc..bed948bf36 100644 --- a/versioned_docs/version-7.0/indexes/boosting.mdx +++ b/versioned_docs/version-7.0/indexes/boosting.mdx @@ -287,7 +287,7 @@ where ShipToCountry == "poland" or CompanyCountry == "portugal" * By default, whenever boosting is applied, either via dynamic querying or when querying an index that has a boosting factor in its definition, the results will be automatically ordered by the score. -* This behavior can be modified using the [OrderByScoreAutomaticallyWhenBoostingIsInvolved](../server/configuration/indexing-configuration.mdx#indexing.orderbyscoreautomaticallywhenboostingisinvolved) +* This behavior can be modified using the [OrderByScoreAutomaticallyWhenBoostingIsInvolved](../server/configuration/indexing-configuration.mdx#indexingorderbyscoreautomaticallywhenboostingisinvolved) configuration key. * Refer to the [Get resulting score](../client-api/session/querying/sort-query-results.mdx#get-resulting-score) @@ -388,7 +388,7 @@ Boosting is also available at the query level. * By default, whenever boosting is involved, either via a dynamic query or when querying an index that has a boosting factor in its definition, the results will be automatically ordered by the score. -* This behavior can be modified using the [OrderByScoreAutomaticallyWhenBoostingIsInvolved](../server/configuration/indexing-configuration.mdx#indexing.orderbyscoreautomaticallywhenboostingisinvolved) +* This behavior can be modified using the [OrderByScoreAutomaticallyWhenBoostingIsInvolved](../server/configuration/indexing-configuration.mdx#indexingorderbyscoreautomaticallywhenboostingisinvolved) configuration key. @@ -686,7 +686,7 @@ where ShipToCountry == "poland" or CompanyCountry == "portugal" * By default, whenever boosting is applied, either via dynamic querying or when querying an index that has a boosting factor in its definition, the results will be automatically ordered by the score. -* This behavior can be modified using the [OrderByScoreAutomaticallyWhenBoostingIsInvolved](../server/configuration/indexing-configuration.mdx#indexing.orderbyscoreautomaticallywhenboostingisinvolved) +* This behavior can be modified using the [OrderByScoreAutomaticallyWhenBoostingIsInvolved](../server/configuration/indexing-configuration.mdx#indexingorderbyscoreautomaticallywhenboostingisinvolved) configuration key. * Refer to the [Get resulting score](../client-api/session/querying/sort-query-results.mdx#get-resulting-score) @@ -859,7 +859,7 @@ where ShipToCountry == "poland" or CompanyCountry == "portugal" * By default, whenever boosting is applied, either via dynamic querying or when querying an index that has a boosting factor in its definition, the results will be automatically ordered by the score. -* This behavior can be modified using the [OrderByScoreAutomaticallyWhenBoostingIsInvolved](../server/configuration/indexing-configuration.mdx#indexing.orderbyscoreautomaticallywhenboostingisinvolved) +* This behavior can be modified using the [OrderByScoreAutomaticallyWhenBoostingIsInvolved](../server/configuration/indexing-configuration.mdx#indexingorderbyscoreautomaticallywhenboostingisinvolved) configuration key. * Refer to the [Get resulting score](../client-api/session/querying/sort-query-results.mdx#get-resulting-score) diff --git a/versioned_docs/version-7.0/indexes/creating-and-deploying.mdx b/versioned_docs/version-7.0/indexes/creating-and-deploying.mdx index b48e332930..c4968e7d39 100644 --- a/versioned_docs/version-7.0/indexes/creating-and-deploying.mdx +++ b/versioned_docs/version-7.0/indexes/creating-and-deploying.mdx @@ -487,12 +487,12 @@ where FirstName = "Robert" and LastName = "King" * This is done in order to avoid marking indexes as idle for databases that were offline for a long period of time, as well as for databases that were just restored from a snapshot or a backup. * To set the time before marking an index as idle, use the - [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key. + [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key. Setting this value too high is not recommended, as it may lead to performance degradation by causing unnecessary and redundant work for the indexes. * An `idle` auto-index will resume its work and return to `normal` state upon its next query, or when resetting the index. * If not resumed, the idle auto-index will be deleted by the server after the time period defined in the - [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key + [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key (72 hours by default). @@ -507,7 +507,7 @@ where FirstName = "Robert" and LastName = "King" **How to disable**: -* You can disable auto-indexes by setting the [Indexing.DisableQueryOptimizerGeneratedIndexes](../server/configuration/indexing-configuration.mdx#indexing.disablequeryoptimizergeneratedindexes) configuration key. +* You can disable auto-indexes by setting the [Indexing.DisableQueryOptimizerGeneratedIndexes](../server/configuration/indexing-configuration.mdx#indexingdisablequeryoptimizergeneratedindexes) configuration key. This will affect all queries made both from the **Client API** and the **Studio**. * Alternatively, you can disable auto-indexes from the Studio. @@ -1187,12 +1187,12 @@ where FirstName = "Robert" and LastName = "King" * This is done in order to avoid marking indexes as idle for databases that were offline for a long period of time, as well as for databases that were just restored from a snapshot or a backup. * To set the time before marking an index as idle, use the - [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key. + [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key. Setting this value too high is not recommended, as it may lead to performance degradation by causing unnecessary and redundant work for the indexes. * An `idle` auto-index will resume its work and return to `normal` state upon its next query, or when resetting the index. * If not resumed, the idle auto-index will be deleted by the server after the time period defined in the - [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key + [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key (72 hours by default). @@ -1207,7 +1207,7 @@ where FirstName = "Robert" and LastName = "King" **How to disable**: -* You can disable auto-indexes by setting the [Indexing.DisableQueryOptimizerGeneratedIndexes](../server/configuration/indexing-configuration.mdx#indexing.disablequeryoptimizergeneratedindexes) configuration key. +* You can disable auto-indexes by setting the [Indexing.DisableQueryOptimizerGeneratedIndexes](../server/configuration/indexing-configuration.mdx#indexingdisablequeryoptimizergeneratedindexes) configuration key. This will affect all queries made both from the **Client API** and the **Studio**. * Alternatively, you can disable auto-indexes from the Studio. diff --git a/versioned_docs/version-7.0/indexes/index-administration.mdx b/versioned_docs/version-7.0/indexes/index-administration.mdx index 8e066eb404..9b4979930d 100644 --- a/versioned_docs/version-7.0/indexes/index-administration.mdx +++ b/versioned_docs/version-7.0/indexes/index-administration.mdx @@ -150,7 +150,7 @@ An index can be in one of the following states: * Specifically, an **auto-index** is marked as _'Idle'_ when the time difference between its last-query-time and the most recent time the database was queried (using any other index) exceeds a configurable threshold. This threshold is set by the - [Indexing.TimeToWaitBeforeMarkingAutoIndexAsIdleInMin](../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforemarkingautoindexasidleinmin) configuration key (30 minutes by default). + [Indexing.TimeToWaitBeforeMarkingAutoIndexAsIdleInMin](../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforemarkingautoindexasidleinmin) configuration key (30 minutes by default). * This mechanism is designed to prevent auto-indexes from being marked as idle in databases that were offline for a long period, had no new data to index, were not queried, or were recently restored from a snapshot or backup. @@ -164,11 +164,11 @@ An index can be in one of the following states: * When [the database is reloaded](../studio/database/settings/database-settings.mdx#how-to-reload-the-database). * If the idle auto-index is Not returned to the _'Normal'_ state, the server will **delete** it after a configurable time period, - set by the [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key (72 hours by default). + set by the [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforedeletingautoindexmarkedasidleinhrs) configuration key (72 hours by default). * Note: The server evaluates whether an auto-index should be marked as idle, or whether an idle auto-index should be deleted, - at intervals defined by the [Indexing.CleanupIntervalInMin](../server/configuration/indexing-configuration.mdx#indexing.cleanupintervalinmin) configuration key (10 minutes by default). + at intervals defined by the [Indexing.CleanupIntervalInMin](../server/configuration/indexing-configuration.mdx#indexingcleanupintervalinmin) configuration key (10 minutes by default). If _TimeToWaitBeforeMarkingAutoIndexAsIdleInMin_ or _TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs_ are set to values smaller than the cleanup interval, the index will be marked as idle or deleted only after the cleanup interval elapses. @@ -201,8 +201,8 @@ An index can be in one of the following states: **Expert configuration options**: -* [Server.IndexingAffinityMask](../server/configuration/server-configuration.mdx#server.indexingaffinitymask) - Control the affinity mask of indexing threads -* [Server.NumberOfUnusedCoresByIndexes](../server/configuration/server-configuration.mdx#server.numberofunusedcoresbyindexes) - Set the number of cores that _won't_ be used by indexes +* [Server.IndexingAffinityMask](../server/configuration/server-configuration.mdx#serverindexingaffinitymask) - Control the affinity mask of indexing threads +* [Server.NumberOfUnusedCoresByIndexes](../server/configuration/server-configuration.mdx#servernumberofunusedcoresbyindexes) - Set the number of cores that _won't_ be used by indexes diff --git a/versioned_docs/version-7.0/indexes/index-throttling.mdx b/versioned_docs/version-7.0/indexes/index-throttling.mdx index dd14345adf..bfd24f3fa0 100644 --- a/versioned_docs/version-7.0/indexes/index-throttling.mdx +++ b/versioned_docs/version-7.0/indexes/index-throttling.mdx @@ -57,7 +57,7 @@ They are therefore expected to remain stale longer than indexes that are process ## Throttling and Batches -The delay in index procession increases the size of Item [batches](../server/configuration/indexing-configuration.mdx#indexing.mapbatchsize) +The delay in index procession increases the size of Item [batches](../server/configuration/indexing-configuration.mdx#indexingmapbatchsize) that are processed during indexing intervals. In special cases, throttled indexes' batches are processed without delay. @@ -72,7 +72,7 @@ In special cases, throttled indexes' batches are processed without delay. ## Setting Index Throttling ### Server-Wide Index Throttling - Index Throttling can be set server-wide using a designated [configuration option](../server/configuration/configuration-options.mdx#settings.json). + Index Throttling can be set server-wide using a designated [configuration option](../server/configuration/configuration-options.mdx#settingsjson). Setting the server-wide configuration option will apply to all databases on a given node. * Set the index throttling time interval in Milliseconds using the `Indexing.Throttling.TimeIntervalInMs` configuration option, e.g.: @@ -129,7 +129,7 @@ and [database](../indexes/index-throttling.mdx#index-throttling-per-database) se The batch size can be left for RavenDB to decide, or you can set it yourself using - the [Indexing.MapBatchSize](../server/configuration/indexing-configuration.mdx#indexing.mapbatchsize) property. + the [Indexing.MapBatchSize](../server/configuration/indexing-configuration.mdx#indexingmapbatchsize) property. {`Configuration = new IndexConfiguration diff --git a/versioned_docs/version-7.0/indexes/indexing-basics.mdx b/versioned_docs/version-7.0/indexes/indexing-basics.mdx index 625990b41d..c5f641bf78 100644 --- a/versioned_docs/version-7.0/indexes/indexing-basics.mdx +++ b/versioned_docs/version-7.0/indexes/indexing-basics.mdx @@ -34,7 +34,7 @@ You can read more about stale indexes [here](../indexes/stale-indexes.mdx). ## Querying -RavenDB uses `Raven Query Language (RQL)`, an SQL-like querying language for querying. The easiest way for us would be to expose a method in which you could pass your RQL-flavored query as a string (we [did](../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) that) and do not bother about anything else. +RavenDB uses `Raven Query Language (RQL)`, an SQL-like querying language for querying. The easiest way for us would be to expose a method in which you could pass your RQL-flavored query as a string (we [did](../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) that) and do not bother about anything else. The fact is that we did not stop at this point. We went much further by exposing LINQ-based querying with strong-type support that hides all Lucene syntax complexity: @@ -66,7 +66,7 @@ where FirstName = 'Robert' -You can also create queries manually by using [DocumentQuery](../client-api/session/querying/document-query/what-is-document-query.mdx) or [RawQuery](../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery), both available as a part of advanced session operations: +You can also create queries manually by using [DocumentQuery](../client-api/session/querying/document-query/what-is-document-query.mdx) or [RawQuery](../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery), both available as a part of advanced session operations: @@ -132,7 +132,7 @@ You can read more about stale indexes [here](../indexes/stale-indexes.mdx). ## Querying -RavenDB uses `Raven Query Language (RQL)`, an SQL-like querying language for querying. The easiest way for us would be to expose a method in which you could pass your RQL-flavored query as a string (we [did](../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) that) and do not bother about anything else. +RavenDB uses `Raven Query Language (RQL)`, an SQL-like querying language for querying. The easiest way for us would be to expose a method in which you could pass your RQL-flavored query as a string (we [did](../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) that) and do not bother about anything else. The fact is that we did not stop at this point. We went much further, by exposing querying methods that hides all Lucene syntax complexity: @@ -154,7 +154,7 @@ where FirstName = 'Robert' -You can also create queries by using [RawQuery](../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery). It is available as a part of advanced session operations: +You can also create queries by using [RawQuery](../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery). It is available as a part of advanced session operations: @@ -209,7 +209,7 @@ You can read more about stale indexes [here](../indexes/stale-indexes.mdx). ## Querying -RavenDB uses `Raven Query Language (RQL)`, an SQL-like querying language for querying. The easiest way for us would be to expose a method in which you could pass your RQL-flavored query as a string (we [did](../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery) that) and do not bother about anything else. +RavenDB uses `Raven Query Language (RQL)`, an SQL-like querying language for querying. The easiest way for us would be to expose a method in which you could pass your RQL-flavored query as a string (we [did](../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery) that) and do not bother about anything else. The fact is that we did not stop at this point. We went much further, by exposing querying methods that hides all Lucene syntax complexity: @@ -231,7 +231,7 @@ where FirstName = 'Robert' -You can also create queries by using [RawQuery](../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery). It is available as a part of advanced session operations: +You can also create queries by using [RawQuery](../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery). It is available as a part of advanced session operations: diff --git a/versioned_docs/version-7.0/indexes/indexing-nested-data.mdx b/versioned_docs/version-7.0/indexes/indexing-nested-data.mdx index 162499432d..d3ed554d11 100644 --- a/versioned_docs/version-7.0/indexes/indexing-nested-data.mdx +++ b/versioned_docs/version-7.0/indexes/indexing-nested-data.mdx @@ -563,7 +563,7 @@ where Color == "black" RavenDB will issue a **High indexing fanout ratio** alert in the Studio notification center. * You can control when this performance hint is created by setting the - [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../server/configuration/performance-hints-configuration.mdx#performancehints.indexing.maxindexoutputsperdocument) configuration key + [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../server/configuration/performance-hints-configuration.mdx#performancehintsindexingmaxindexoutputsperdocument) configuration key (default is 1024). * So, for example, adding another OnlineShop document with a `tShirt` object containing 1025 items @@ -1135,7 +1135,7 @@ where Color == "black" RavenDB will issue a **High indexing fanout ratio** alert in the Studio notification center. * You can control when this performance hint is created by setting the - [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../server/configuration/performance-hints-configuration.mdx#performancehints.indexing.maxindexoutputsperdocument) configuration key + [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../server/configuration/performance-hints-configuration.mdx#performancehintsindexingmaxindexoutputsperdocument) configuration key (default is 1024). * So, for example, adding another OnlineShop document with a `tShirt` object containing 1025 items @@ -1757,7 +1757,7 @@ where Color == "black" RavenDB will issue a **High indexing fanout ratio** alert in the Studio notification center. * You can control when this performance hint is created by setting the - [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../server/configuration/performance-hints-configuration.mdx#performancehints.indexing.maxindexoutputsperdocument) configuration key + [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../server/configuration/performance-hints-configuration.mdx#performancehintsindexingmaxindexoutputsperdocument) configuration key (default is 1024). * So, for example, adding another OnlineShop document with a `tShirt` object containing 1025 items @@ -2154,7 +2154,7 @@ where color == "black" RavenDB will issue a **High indexing fanout ratio** alert in the Studio notification center. * You can control when this performance hint is created by setting the - [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../server/configuration/performance-hints-configuration.mdx#performancehints.indexing.maxindexoutputsperdocument) configuration key + [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../server/configuration/performance-hints-configuration.mdx#performancehintsindexingmaxindexoutputsperdocument) configuration key (default is 1024). * So, for example, adding another OnlineShop document with a `tShirt` object containing 1025 items diff --git a/versioned_docs/version-7.0/indexes/javascript-indexes.mdx b/versioned_docs/version-7.0/indexes/javascript-indexes.mdx index e92d2eef48..d16fc54618 100644 --- a/versioned_docs/version-7.0/indexes/javascript-indexes.mdx +++ b/versioned_docs/version-7.0/indexes/javascript-indexes.mdx @@ -73,7 +73,7 @@ export const supportedLanguages = ["csharp", "java"]; while **C# static indexes** require a [User/Admin](../server/security/authorization/security-clearance-and-permissions.mdx#section) certificate or higher. * To restrict the creation of JavaScript indexes to database admins (and above), - set the [Indexing.Static.RequireAdminToDeployJavaScriptIndexes](../server/configuration/indexing-configuration.mdx#indexing.static.requireadmintodeployjavascriptindexes) configuration to `true`. + set the [Indexing.Static.RequireAdminToDeployJavaScriptIndexes](../server/configuration/indexing-configuration.mdx#indexingstaticrequireadmintodeployjavascriptindexes) configuration to `true`. * All other capabilities and features of JavaScript indexes are identical to those of [C# indexes](../indexes/indexing-basics.mdx). @@ -231,7 +231,7 @@ public class BlogPostComment #### Example III - Map index - with inline string compilation * To define a JavaScript index using inline string compilation, - you must set the [Indexing.AllowStringCompilation](../server/configuration/indexing-configuration.mdx#indexing.allowstringcompilation) configuration key to _true_. + you must set the [Indexing.AllowStringCompilation](../server/configuration/indexing-configuration.mdx#indexingallowstringcompilation) configuration key to _true_. * The following indexes use inline string compilation to evaluate whether each product’s `UnitsInStock` is low. diff --git a/versioned_docs/version-7.0/indexes/map-indexes.mdx b/versioned_docs/version-7.0/indexes/map-indexes.mdx index 28bfe803e9..9ffcdb8431 100644 --- a/versioned_docs/version-7.0/indexes/map-indexes.mdx +++ b/versioned_docs/version-7.0/indexes/map-indexes.mdx @@ -855,10 +855,10 @@ Learn more [here](../indexes/indexing-related-documents.mdx). ## Indexing Missing Fields By default, indexes will not index a document that contains none of the specified fields. This behavior can be changed -using the [Indexing.IndexEmptyEntries](../server/configuration/indexing-configuration.mdx#indexing.indexemptyentries) +using the [Indexing.IndexEmptyEntries](../server/configuration/indexing-configuration.mdx#indexingindexemptyentries) configuration option. -The option [Indexing.IndexMissingFieldsAsNull](../server/configuration/indexing-configuration.mdx#indexing.indexmissingfieldsasnull) +The option [Indexing.IndexMissingFieldsAsNull](../server/configuration/indexing-configuration.mdx#indexingindexmissingfieldsasnull) determines whether missing fields in documents are indexed with the value `null`, or not indexed at all. @@ -2082,10 +2082,10 @@ Learn more [here](../indexes/indexing-related-documents.mdx). ## Indexing Missing Fields By default, indexes will not index a document that contains none of the specified fields. This behavior can be changed -using the [Indexing.IndexEmptyEntries](../server/configuration/indexing-configuration.mdx#indexing.indexemptyentries) +using the [Indexing.IndexEmptyEntries](../server/configuration/indexing-configuration.mdx#indexingindexemptyentries) configuration option. -The option [Indexing.IndexMissingFieldsAsNull](../server/configuration/indexing-configuration.mdx#indexing.indexmissingfieldsasnull) +The option [Indexing.IndexMissingFieldsAsNull](../server/configuration/indexing-configuration.mdx#indexingindexmissingfieldsasnull) determines whether missing fields in documents are indexed with the value `null`, or not indexed at all. @@ -2869,10 +2869,10 @@ Learn more [here](../indexes/indexing-related-documents.mdx). ## Indexing Missing Fields By default, indexes will not index a document that contains none of the specified fields. This behavior can be changed -using the [Indexing.IndexEmptyEntries](../server/configuration/indexing-configuration.mdx#indexing.indexemptyentries) +using the [Indexing.IndexEmptyEntries](../server/configuration/indexing-configuration.mdx#indexingindexemptyentries) configuration option. -The option [Indexing.IndexMissingFieldsAsNull](../server/configuration/indexing-configuration.mdx#indexing.indexmissingfieldsasnull) +The option [Indexing.IndexMissingFieldsAsNull](../server/configuration/indexing-configuration.mdx#indexingindexmissingfieldsasnull) determines whether missing fields in documents are indexed with the value `null`, or not indexed at all. @@ -3246,10 +3246,10 @@ If a document relationship is represented by the document's ID, you can use the ## Indexing Missing Fields By default, indexes will not index a document that contains none of the specified fields. This behavior can be changed -using the [Indexing.IndexEmptyEntries](../server/configuration/indexing-configuration.mdx#indexing.indexemptyentries) +using the [Indexing.IndexEmptyEntries](../server/configuration/indexing-configuration.mdx#indexingindexemptyentries) configuration option. -The option [Indexing.IndexMissingFieldsAsNull](../server/configuration/indexing-configuration.mdx#indexing.indexmissingfieldsasnull) +The option [Indexing.IndexMissingFieldsAsNull](../server/configuration/indexing-configuration.mdx#indexingindexmissingfieldsasnull) determines whether missing fields in documents are indexed with the value `null`, or not indexed at all. diff --git a/versioned_docs/version-7.0/indexes/querying/exploration-queries.mdx b/versioned_docs/version-7.0/indexes/querying/exploration-queries.mdx index 645515e86c..540fbb6b9c 100644 --- a/versioned_docs/version-7.0/indexes/querying/exploration-queries.mdx +++ b/versioned_docs/version-7.0/indexes/querying/exploration-queries.mdx @@ -22,9 +22,9 @@ export const supportedLanguages = ["csharp", "python", "php", "nodejs"]; * **Exploration Queries** form an additional layer of filtering that can be applied - to a dataset after its retrieval by [Query](../../client-api/session/querying/how-to-query.mdx#session.query), - [DocumentQuery](../../client-api/session/querying/how-to-query.mdx#session.advanced.documentquery), - or [Raw RQL](../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery), + to a dataset after its retrieval by [Query](../../client-api/session/querying/how-to-query.mdx#sessionquery), + [DocumentQuery](../../client-api/session/querying/how-to-query.mdx#sessionadvanceddocumentquery), + or [Raw RQL](../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery), while the dataset is still held by the server. * The **retrieved dataset** is scanned and filtered **without requiring or creating an @@ -347,7 +347,7 @@ filter_limit 100 * **Exploration Queries** form an additional layer of filtering that can be applied - to a dataset after its retrieval by [raw_rql](../../client-api/session/querying/how-to-query.mdx#session.advanced.raw_query), + to a dataset after its retrieval by [raw_rql](../../client-api/session/querying/how-to-query.mdx#sessionadvancedraw_query), while the dataset is still held by the server. * The **retrieved dataset** is scanned and filtered **without requiring or creating an @@ -578,7 +578,7 @@ filter_limit 100 * **Exploration Queries** form an additional layer of filtering that can be applied - to a dataset after its retrieval by [raw rql](../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery), + to a dataset after its retrieval by [raw rql](../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery), while the dataset is still held by the server. * The **retrieved dataset** is scanned and filtered **without requiring or creating an @@ -864,8 +864,8 @@ filter_limit 100 * **Exploration Queries** form an additional layer of filtering that can be applied - to a dataset after its retrieval by [query](../../client-api/session/querying/how-to-query.mdx#session.query), - or [rawQuery](../../client-api/session/querying/how-to-query.mdx#session.advanced.rawquery), + to a dataset after its retrieval by [query](../../client-api/session/querying/how-to-query.mdx#sessionquery), + or [rawQuery](../../client-api/session/querying/how-to-query.mdx#sessionadvancedrawquery), while the dataset is still held by the server. * The **retrieved dataset** is scanned and filtered **without requiring or creating an index**, diff --git a/versioned_docs/version-7.0/indexes/querying/paging.mdx b/versioned_docs/version-7.0/indexes/querying/paging.mdx index c9894715ea..a7bc0a42b6 100644 --- a/versioned_docs/version-7.0/indexes/querying/paging.mdx +++ b/versioned_docs/version-7.0/indexes/querying/paging.mdx @@ -406,7 +406,7 @@ This practice has several benefits: * By default, if the number of returned results exceeds **2048**, the server will issue a "Page size too big" notification (visible in the Studio) with information about the query. -* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehints.maxnumberofresults) configuration key. +* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehintsmaxnumberofresults) configuration key. * As suggested by the hint, you may consider using [Streaming query results](../../client-api/session/querying/how-to-stream-query-results.mdx) instead of paging. @@ -967,7 +967,7 @@ This practice has several benefits: * By default, if the number of returned results exceeds **2048**, the server will issue a "Page size too big" notification (visible in the Studio) with information about the query. -* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehints.maxnumberofresults) configuration key. +* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehintsmaxnumberofresults) configuration key. * As suggested by the hint, you may consider using [Streaming query results](../../client-api/session/querying/how-to-stream-query-results.mdx) instead of paging. @@ -1336,7 +1336,7 @@ This practice has several benefits: * By default, if the number of returned results exceeds **2048**, the server will issue a "Page size too big" notification (visible in the Studio) with information about the query. -* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehints.maxnumberofresults) configuration key. +* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehintsmaxnumberofresults) configuration key. * As suggested by this performance hint, you may consider using [Streaming query results](../../client-api/session/querying/how-to-stream-query-results.mdx) instead of paging. @@ -1884,7 +1884,7 @@ This practice has several benefits: * By default, if the number of returned results exceeds **2048**, the server will issue a "Page size too big" notification (visible in the Studio) with information about the query. -* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehints.maxnumberofresults) configuration key. +* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehintsmaxnumberofresults) configuration key. * As suggested by this performance hint, you may consider using [Streaming query results](../../client-api/session/querying/how-to-stream-query-results.mdx) instead of paging. @@ -2430,7 +2430,7 @@ This practice has several benefits: * By default, if the number of returned results exceeds **2048**, the server will issue a "Page size too big" notification (visible in the Studio) with information about the query. -* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehints.maxnumberofresults) configuration key. +* This threshold can be customized by modifying the value of the [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehintsmaxnumberofresults) configuration key. * As suggested by the hint, you may consider using [Streaming query results](../../client-api/session/querying/how-to-stream-query-results.mdx) instead of paging. diff --git a/versioned_docs/version-7.0/indexes/querying/query-index.mdx b/versioned_docs/version-7.0/indexes/querying/query-index.mdx index 09c678c5af..71f4378142 100644 --- a/versioned_docs/version-7.0/indexes/querying/query-index.mdx +++ b/versioned_docs/version-7.0/indexes/querying/query-index.mdx @@ -478,8 +478,8 @@ where LastName == "King" ## Query an index by `RawQuery` -* Queries defined with [Query](../../indexes/querying/query-index.mdx#session.query) - or [DocumentQuery](../../indexes/querying/query-index.mdx#session.advanced.documentquery) +* Queries defined with [Query](../../indexes/querying/query-index.mdx#sessionquery) + or [DocumentQuery](../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) are translated by the RavenDB client to [RQL](../../client-api/session/querying/what-is-rql.mdx) when sent to the server. @@ -1007,8 +1007,8 @@ limit 5, 10 // skip 5, take 10 ## Query an index by `raw_query` -* Queries defined with [Query](../../indexes/querying/query-index.mdx#session.query) - or [DocumentQuery](../../indexes/querying/query-index.mdx#session.advanced.documentquery) +* Queries defined with [Query](../../indexes/querying/query-index.mdx#sessionquery) + or [DocumentQuery](../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) are translated by the RavenDB client to [RQL](../../client-api/session/querying/what-is-rql.mdx) when sent to the server. @@ -1520,8 +1520,8 @@ where LastName == "King" ## Query an index by `rawQuery` -* Queries defined with [Query](../../indexes/querying/query-index.mdx#session.query) - or [DocumentQuery](../../indexes/querying/query-index.mdx#session.advanced.documentquery) +* Queries defined with [Query](../../indexes/querying/query-index.mdx#sessionquery) + or [DocumentQuery](../../indexes/querying/query-index.mdx#sessionadvanceddocumentquery) are translated by the RavenDB client to [RQL](../../client-api/session/querying/what-is-rql.mdx) when sent to the server. @@ -1890,7 +1890,7 @@ limit 5, 10 // skip 5, take 10 ## Query an index by `RawQuery` -* Queries defined with [query](../../indexes/querying/query-index.mdx#session.query) 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](../../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. * 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.0/indexes/rolling-index-deployment.mdx b/versioned_docs/version-7.0/indexes/rolling-index-deployment.mdx index 907fb4f1c1..dd67018bd6 100644 --- a/versioned_docs/version-7.0/indexes/rolling-index-deployment.mdx +++ b/versioned_docs/version-7.0/indexes/rolling-index-deployment.mdx @@ -89,7 +89,7 @@ Nodes are assigned with the indexing of each database in a linear order, one nod ## Setting Indexing Deployment Mode ### Server-Wide Deployment Mode - Deployment mode can be set server-wide using [configuration options](../server/configuration/configuration-options.mdx#settings.json). + Deployment mode can be set server-wide using [configuration options](../server/configuration/configuration-options.mdx#settingsjson). Setting the server-wide configuration option will apply to all databases on a given node. * [Auto Indexes](../indexes/creating-and-deploying.mdx#auto-indexes) Deployment Mode diff --git a/versioned_docs/version-7.0/indexes/search-engine/corax.mdx b/versioned_docs/version-7.0/indexes/search-engine/corax.mdx index 0dfd99ec01..b13bca68df 100644 --- a/versioned_docs/version-7.0/indexes/search-engine/corax.mdx +++ b/versioned_docs/version-7.0/indexes/search-engine/corax.mdx @@ -63,17 +63,17 @@ import LanguageContent from "@site/src/components/LanguageContent"; * These configuration options are available: - * [Indexing.Auto.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexing.auto.searchenginetype) + * [Indexing.Auto.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexingautosearchenginetype) Use this option to select the search engine (either `Lucene` or `Corax`) for **auto** indexes. The search engine can be selected **server-wide** or **per database**. - * [Indexing.Static.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexing.static.searchenginetype) + * [Indexing.Static.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexingstaticsearchenginetype) Use this option to select the search engine (either `Lucene` or `Corax`) for **static** indexes. The search engine can be selected **server-wide**, **per database**, or **per index**. * Read about additional Corax configuration options [here](../../indexes/search-engine/corax.mdx#configuration-options). ### Select search engine: Server wide Select the search engine for all the databases hosted by a server -by modifying the server's [settings.json](../../server/configuration/configuration-options.mdx#settings.json) file. +by modifying the server's [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) file. E.g. - @@ -397,7 +397,7 @@ a static index. * **New static index** (created or reset on RavenDB `6.2.x` and on) The index will behave as determined by the - [Indexing.Corax.Static.ComplexFieldIndexingBehavior](../../server/configuration/indexing-configuration.mdx#indexing.corax.static.complexfieldindexingbehavior) + [Indexing.Corax.Static.ComplexFieldIndexingBehavior](../../server/configuration/indexing-configuration.mdx#indexingcoraxstaticcomplexfieldindexingbehavior) configuration option. * If `ComplexFieldIndexingBehavior` is set to **`Throw`** - Corax will throw a `NotSupportedInCoraxException` exception with this message: @@ -519,39 +519,39 @@ order by Location Corax configuration options include: -* [Indexing.Auto.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexing.auto.searchenginetype) +* [Indexing.Auto.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexingautosearchenginetype) [Select](../../indexes/search-engine/corax.mdx#selecting-the-search-engine) the search engine for **Auto** indexes. -* [Indexing.Static.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexing.static.searchenginetype) +* [Indexing.Static.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexingstaticsearchenginetype) [Select](../../indexes/search-engine/corax.mdx#selecting-the-search-engine) the search engine for **Static** indexes. -* [Indexing.Corax.IncludeDocumentScore](../../server/configuration/indexing-configuration.mdx#indexing.corax.includedocumentscore) +* [Indexing.Corax.IncludeDocumentScore](../../server/configuration/indexing-configuration.mdx#indexingcoraxincludedocumentscore) Choose whether to include the score value in document metadata when sorting by score. Disabling this option can improve query performance. -* [Indexing.Corax.IncludeSpatialDistance](../../server/configuration/indexing-configuration.mdx#indexing.corax.includespatialdistance) +* [Indexing.Corax.IncludeSpatialDistance](../../server/configuration/indexing-configuration.mdx#indexingcoraxincludespatialdistance) Choose whether to include spatial information in document metadata when sorting by distance. Disabling this option can improve query performance. -* [Indexing.Corax.MaxMemoizationSizeInMb](../../server/configuration/indexing-configuration.mdx#indexing.corax.maxmemoizationsizeinmb) +* [Indexing.Corax.MaxMemoizationSizeInMb](../../server/configuration/indexing-configuration.mdx#indexingcoraxmaxmemoizationsizeinmb) The maximum amount of memory that Corax can use for a memoization clause during query processing. Please configure this option only if you are an expert. -* [Indexing.Corax.DocumentsLimitForCompressionDictionaryCreation](../../server/configuration/indexing-configuration.mdx#indexing.corax.documentslimitforcompressiondictionarycreation) +* [Indexing.Corax.DocumentsLimitForCompressionDictionaryCreation](../../server/configuration/indexing-configuration.mdx#indexingcoraxdocumentslimitforcompressiondictionarycreation) Set the maximum number of documents that will be used for the training of a Corax index during dictionary creation. Training will stop when it reaches this limit. -* [Indexing.Corax.MaxAllocationsAtDictionaryTrainingInMb](../../server/configuration/indexing-configuration.mdx#indexing.corax.maxallocationsatdictionarytraininginmb) +* [Indexing.Corax.MaxAllocationsAtDictionaryTrainingInMb](../../server/configuration/indexing-configuration.mdx#indexingcoraxmaxallocationsatdictionarytraininginmb) Set the maximum amount of memory (in MB) that will be allocated for the training of a Corax index during dictionary creation. Training will stop when it reaches this limit. -* [Indexing.Corax.Static.ComplexFieldIndexingBehavior](../../server/configuration/indexing-configuration.mdx#indexing.corax.static.complexfieldindexingbehavior) +* [Indexing.Corax.Static.ComplexFieldIndexingBehavior](../../server/configuration/indexing-configuration.mdx#indexingcoraxstaticcomplexfieldindexingbehavior) Choose [how to react](../../indexes/search-engine/corax.mdx#if-corax-encounters-a-complex-property-while-indexing) when a static Corax index is requested to index a complex JSON object. @@ -578,14 +578,14 @@ Here are some additional things to keep in mind about Corax indexes compression * The benefits of compression dictionaries are most pronounced for large collections. Training stops when it reaches either the - [number of documents](../../server/configuration/indexing-configuration.mdx#indexing.corax.documentslimitforcompressiondictionarycreation) + [number of documents](../../server/configuration/indexing-configuration.mdx#indexingcoraxdocumentslimitforcompressiondictionarycreation) threshold (100,000 docs by default) or the - [amount of memory](../../server/configuration/indexing-configuration.mdx#indexing.corax.maxallocationsatdictionarytraininginmb) + [amount of memory](../../server/configuration/indexing-configuration.mdx#indexingcoraxmaxallocationsatdictionarytraininginmb) threshold (up to 2GB). Both thresholds are configurable. * If upon creation there are less than 10,000 documents in the involved collections, it may make sense to manually force an index reset after reaching - [100,000](../../server/configuration/indexing-configuration.mdx#indexing.corax.documentslimitforcompressiondictionarycreation) + [100,000](../../server/configuration/indexing-configuration.mdx#indexingcoraxdocumentslimitforcompressiondictionarycreation) documents to force retraining. Indexes are replaced in a [side-by-side](../../studio/database/indexes/indexes-list-view.mdx#indexes-list-view---side-by-side-indexing) diff --git a/versioned_docs/version-7.0/indexes/using-analyzers.mdx b/versioned_docs/version-7.0/indexes/using-analyzers.mdx index 326691a899..bbfd4038e1 100644 --- a/versioned_docs/version-7.0/indexes/using-analyzers.mdx +++ b/versioned_docs/version-7.0/indexes/using-analyzers.mdx @@ -281,7 +281,7 @@ There are two exceptions to this rule: 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: - * Increase the [MaxGram](../server/configuration/indexing-configuration.mdx#indexing.lucene.analyzers.ngram.maxgram) value to generate larger tokens during indexing (when using Lucene). + * Increase the [MaxGram](../server/configuration/indexing-configuration.mdx#indexingluceneanalyzersngrammaxgram) value to generate larger tokens during indexing (when using Lucene). * Use a different analyzer other than _NGramAnalyzer_ that better matches your requirements. 2. Behavior is also different when making a full-text search with wildcards in the search terms. @@ -459,8 +459,8 @@ All examples below use the following text: * **Overriding default token length**: (only when using Lucene as the search engine) You can override the default token lengths of the NGram analyzer by setting the following configuration keys: - [Indexing.Lucene.Analyzers.NGram.MinGram](../server/configuration/indexing-configuration.mdx#indexing.lucene.analyzers.ngram.mingram) - and [Indexing.Lucene.Analyzers.NGram.MaxGram](../server/configuration/indexing-configuration.mdx#indexing.lucene.analyzers.ngram.maxgram). + [Indexing.Lucene.Analyzers.NGram.MinGram](../server/configuration/indexing-configuration.mdx#indexingluceneanalyzersngrammingram) + and [Indexing.Lucene.Analyzers.NGram.MaxGram](../server/configuration/indexing-configuration.mdx#indexingluceneanalyzersngrammaxgram). For example, setting them to 3 and 4, respectively, will generate the following tokens: @@ -577,7 +577,7 @@ store.Maintenance.Send(new PutIndexesOperation(indexDefinition)); By default, this analyzer is the `RavenStandardAnalyzer` (inherits from Lucene's _StandardAnalyzer_). * To customize a different analyzer that will serve as your Default Search Analyzer, - set the [Indexing.Analyzers.Search.Default](../server/configuration/indexing-configuration.mdx#indexing.analyzers.search.default) configuration key. + set the [Indexing.Analyzers.Search.Default](../server/configuration/indexing-configuration.mdx#indexinganalyzerssearchdefault) configuration key. * Using a search analyzer enables full-text search queries against the field. Given the same sample text from above, _RavenStandardAnalyzer_ will produce the following tokens: @@ -623,7 +623,7 @@ store.Maintenance.Send(new PutIndexesOperation(indexDefinition)); The field's value is indexed exactly as provided, enabling precise, case-sensitive matching at query time. * To customize a different analyzer that will serve as your Default Exact Analyzer, - set the [Indexing.Analyzers.Exact.Default ](../server/configuration/indexing-configuration.mdx#indexing.analyzers.exact.default) configuration key. + set the [Indexing.Analyzers.Exact.Default ](../server/configuration/indexing-configuration.mdx#indexinganalyzersexactdefault) configuration key. * Given the same sample text from above, _KeywordAnalyzer_ will produce a single token: `[The quick brown fox jumped over the lazy dogs, Bob@hotmail.com 123432.]` @@ -666,7 +666,7 @@ store.Maintenance.Send(new PutIndexesOperation(indexDefinition)); The entire content of the field is processed into a single, lowercased token. * To customize a different analyzer that will serve as your Default Analyzer, - set the [Indexing.Analyzers.Default](../server/configuration/indexing-configuration.mdx#indexing.analyzers.default) configuration key. + set the [Indexing.Analyzers.Default](../server/configuration/indexing-configuration.mdx#indexinganalyzersdefault) configuration key. * Given the same sample text from above, _LowerCaseKeywordAnalyzer_ will produce a single token: `[the quick brown fox jumped over the lazy dogs, bob@hotmail.com 123432.]` @@ -970,7 +970,7 @@ There are two exceptions to this rule: 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: - * Increase the [MaxGram](../server/configuration/indexing-configuration.mdx#indexing.lucene.analyzers.ngram.maxgram) value to generate larger tokens during indexing (when using Lucene). + * Increase the [MaxGram](../server/configuration/indexing-configuration.mdx#indexingluceneanalyzersngrammaxgram) value to generate larger tokens during indexing (when using Lucene). * Use a different analyzer other than _NGramAnalyzer_ that better matches your requirements. 2. Behavior is also different when making a full-text search with wildcards in the search terms. @@ -1148,8 +1148,8 @@ All examples below use the following text: * **Overriding default token length**: (only when using Lucene as the search engine) You can override the default token lengths of the NGram analyzer by setting the following configuration keys: - [Indexing.Lucene.Analyzers.NGram.MinGram](../server/configuration/indexing-configuration.mdx#indexing.lucene.analyzers.ngram.mingram) - and [Indexing.Lucene.Analyzers.NGram.MaxGram](../server/configuration/indexing-configuration.mdx#indexing.lucene.analyzers.ngram.maxgram). + [Indexing.Lucene.Analyzers.NGram.MinGram](../server/configuration/indexing-configuration.mdx#indexingluceneanalyzersngrammingram) + and [Indexing.Lucene.Analyzers.NGram.MaxGram](../server/configuration/indexing-configuration.mdx#indexingluceneanalyzersngrammaxgram). For example, setting them to 3 and 4, respectively, will generate the following tokens: @@ -1250,7 +1250,7 @@ await store.maintenance By default, this analyzer is the `RavenStandardAnalyzer` (inherits from Lucene's _StandardAnalyzer_). * To customize a different analyzer that will serve as your Default Search Analyzer, - set the [Indexing.Analyzers.Search.Default](../server/configuration/indexing-configuration.mdx#indexing.analyzers.search.default) configuration key. + set the [Indexing.Analyzers.Search.Default](../server/configuration/indexing-configuration.mdx#indexinganalyzerssearchdefault) configuration key. * Using a search analyzer enables full-text search queries against the field. Given the same sample text from above, _RavenStandardAnalyzer_ will produce the following tokens: @@ -1293,7 +1293,7 @@ await store.maintenance The field's value is indexed exactly as provided, enabling precise, case-sensitive matching at query time. * To customize a different analyzer that will serve as your Default Exact Analyzer, - set the [Indexing.Analyzers.Exact.Default ](../server/configuration/indexing-configuration.mdx#indexing.analyzers.exact.default) configuration key. + set the [Indexing.Analyzers.Exact.Default ](../server/configuration/indexing-configuration.mdx#indexinganalyzersexactdefault) configuration key. * Given the same sample text from above, _KeywordAnalyzer_ will produce a single token: `[The quick brown fox jumped over the lazy dogs, Bob@hotmail.com 123432.]` @@ -1334,7 +1334,7 @@ await store.maintenance The entire content of the field is processed into a single, lowercased token. * To customize a different analyzer that will serve as your Default Analyzer, - set the [Indexing.Analyzers.Default](../server/configuration/indexing-configuration.mdx#indexing.analyzers.default) configuration key. + set the [Indexing.Analyzers.Default](../server/configuration/indexing-configuration.mdx#indexinganalyzersdefault) configuration key. * Given the same sample text from above, _LowerCaseKeywordAnalyzer_ will produce a single token: `[the quick brown fox jumped over the lazy dogs, bob@hotmail.com 123432.]` diff --git a/versioned_docs/version-7.0/integrations/akka.net-persistence/integrating-with-akka-persistence.mdx b/versioned_docs/version-7.0/integrations/akka.net-persistence/integrating-with-akka-persistence.mdx index fe4176cb57..55b371bccc 100644 --- a/versioned_docs/version-7.0/integrations/akka.net-persistence/integrating-with-akka-persistence.mdx +++ b/versioned_docs/version-7.0/integrations/akka.net-persistence/integrating-with-akka-persistence.mdx @@ -19,7 +19,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * 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#akka.persistence.ravendb) + * [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) diff --git a/versioned_docs/version-7.0/integrations/postgresql-protocol/overview.mdx b/versioned_docs/version-7.0/integrations/postgresql-protocol/overview.mdx index c00f9cd25f..a5402e201a 100644 --- a/versioned_docs/version-7.0/integrations/postgresql-protocol/overview.mdx +++ b/versioned_docs/version-7.0/integrations/postgresql-protocol/overview.mdx @@ -47,7 +47,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; If your current license doesn't include Power BI Support, you can acquire one that does [here](https://ravendb.net/buy). ### Settings -* PostgreSQL protocol support must be explicitly enabled in your [settings](../../server/configuration/configuration-options.mdx#settings.json). +* PostgreSQL protocol support must be explicitly enabled in your [settings](../../server/configuration/configuration-options.mdx#settingsjson). Add this line to your server's `settings.json` file to enable the PostgreSQL protocol: @@ -56,7 +56,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * PostgreSQL is an experimental feature. To enable it, enable RavenDB's - [Experimental Features](../../server/configuration/core-configuration.mdx#features.availability) + [Experimental Features](../../server/configuration/core-configuration.mdx#featuresavailability) by adding this line to your server's `settings.json` file: diff --git a/versioned_docs/version-7.0/migration/client-api/client-breaking-changes.mdx b/versioned_docs/version-7.0/migration/client-api/client-breaking-changes.mdx index beeda62249..def25146f6 100644 --- a/versioned_docs/version-7.0/migration/client-api/client-breaking-changes.mdx +++ b/versioned_docs/version-7.0/migration/client-api/client-breaking-changes.mdx @@ -118,7 +118,7 @@ Clients can switch to a different HTTP-Compression algorithm using `DocumentStor If you migrate from an earlier RavenDB version to version `7.0` or higher, -please note the [potential significance of this change](../../migration/client-api/client-migration.mdx#client-migration-to-ravendb-7.x). +please note the [potential significance of this change](../../migration/client-api/client-migration.mdx#client-migration-to-ravendb-7x). diff --git a/versioned_docs/version-7.0/migration/client-api/client-migration.mdx b/versioned_docs/version-7.0/migration/client-api/client-migration.mdx index 08e0b446bf..896d925074 100644 --- a/versioned_docs/version-7.0/migration/client-api/client-migration.mdx +++ b/versioned_docs/version-7.0/migration/client-api/client-migration.mdx @@ -16,7 +16,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-7.x) + * [Client migration to RavenDB `7.x`](../../migration/client-api/client-migration.mdx#client-migration-to-ravendb-7x) ## Client migration to RavenDB `7.x` diff --git a/versioned_docs/version-7.0/migration/server/data-migration.mdx b/versioned_docs/version-7.0/migration/server/data-migration.mdx index 2ef5da0380..0535185fc9 100644 --- a/versioned_docs/version-7.0/migration/server/data-migration.mdx +++ b/versioned_docs/version-7.0/migration/server/data-migration.mdx @@ -16,10 +16,10 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Migration to RavenDB `7.x`](../../migration/server/data-migration.mdx#migration-to-ravendb-7.x) - * [Migration from RavenDB 5.x to 6.x](../../migration/server/data-migration.mdx#migration-from-ravendb-5.x-to-6.x) - * [Migration from RavenDB 4.x to RavenDB 5.x and 6.x](../../migration/server/data-migration.mdx#migration-from-ravendb-4.x-to-ravendb-5.x-and-6.x) - * [Migration from RavenDB 3.x](../../migration/server/data-migration.mdx#migration-from-ravendb-3.x) + * [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) @@ -66,7 +66,7 @@ Earlier versions used `Gzip`. * RavenDB `6.x` supports in-place data migration from RavenDB `5.x`. * RavenDB `5.x` product licenses **do not apply** to RavenDB `6.x`. To upgrade a valid `5.x` license to a RavenDB `6.x` license, - please use the **License upgrade tool** [as explained here](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6.x). + please use the **License upgrade tool** [as explained here](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6x). Please note that once upgraded, RavenDB `6.x` cannot be downgraded to version `5.x`, @@ -86,7 +86,7 @@ and the migrated data will no longer be accessible via RavenDB `5.x`. * RavenDB `4.x` product licenses **do not apply** to RavenDB `6.x`. To upgrade a valid `4.x` license to a RavenDB `6.x` license, - please use the **License upgrade tool** [as explained here](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6.x). + please use the **License upgrade tool** [as explained here](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6x). Please note that once upgraded, RavenDB `6.x` cannot be downgraded to version `4.x`, diff --git a/versioned_docs/version-7.0/migration/server/docker.mdx b/versioned_docs/version-7.0/migration/server/docker.mdx index ce699c3d4f..71f5b23e88 100644 --- a/versioned_docs/version-7.0/migration/server/docker.mdx +++ b/versioned_docs/version-7.0/migration/server/docker.mdx @@ -26,8 +26,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Read [here](../../start/containers/image-usage.mdx) more about running a RavenDB Docker image. * In this page: - * [Changes Made In RavenDB `6.0` And Up](../../migration/server/docker.mdx#changes-made-in-ravendb-6.0-and-up) - * [Migrating To `6.0` And Up](../../migration/server/docker.mdx#migrating-to-6.0-and-up) + * [Changes Made In RavenDB `6.0` And Up](../../migration/server/docker.mdx#changes-made-in-ravendb-60-and-up) + * [Migrating To `6.0` And Up](../../migration/server/docker.mdx#migrating-to-60-and-up) ## Changes Made In RavenDB 6.0 And Up diff --git a/versioned_docs/version-7.0/server/administration/cli.mdx b/versioned_docs/version-7.0/server/administration/cli.mdx index 9bde4dea0c..49db6354b4 100644 --- a/versioned_docs/version-7.0/server/administration/cli.mdx +++ b/versioned_docs/version-7.0/server/administration/cli.mdx @@ -119,7 +119,7 @@ Enable (or disable) online log printing to the console. | Parameters | Description | | ------------- | ------------- | | `http-on` or `http-off` | Enables or disables HTTP requests log information | -| `info`, `debug` | Sets logging to the requested [level](../../server/configuration/logs-configuration.mdx#logs.minlevel) | +| `info`, `debug` | Sets logging to the requested [level](../../server/configuration/logs-configuration.mdx#logsminlevel) | | `on` or `off` | Enables or disables log printing | | `no-console` | Disables logging to console | diff --git a/versioned_docs/version-7.0/server/administration/monitoring/open-telemetry.mdx b/versioned_docs/version-7.0/server/administration/monitoring/open-telemetry.mdx index 3e89269403..8aae6d4505 100644 --- a/versioned_docs/version-7.0/server/administration/monitoring/open-telemetry.mdx +++ b/versioned_docs/version-7.0/server/administration/monitoring/open-telemetry.mdx @@ -43,7 +43,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; ## Enabling OpenTelemetry in RavenDB * To enable the OpenTelemetry metrics in RavenDB, - you **must** first set the [Monitoring.OpenTelemetry.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.enabled) configuration key to _true_. + you **must** first set the [Monitoring.OpenTelemetry.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryenabled) configuration key to _true_. * Learn how to customize configuration keys in the [Configuration Overview](../../../server/configuration/configuration-options.mdx) article, which outlines all available options. @@ -65,41 +65,41 @@ RavenDB exposes the following meters: * **ravendb.server.cpucredits** Description: Exposes status of CPU credits (cloud) Enabled by default: _false_ - Configuration key: [Monitoring.OpenTelemetry.Meters.Server.CPUCredits.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.cpucredits.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.Server.CPUCredits.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersservercpucreditsenabled) * **ravendb.server.gc** Description: Exposes detailed information about the Garbage Collector Enabled by default: _false_ - Configuration key: [Monitoring.OpenTelemetry.Meters.Server.GC.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.gc.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.Server.GC.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersservergcenabled) * **ravendb.server.general** Description: Exposes general info about the cluster and its licensing Enabled by default: _true_ - Configuration key: [Monitoring.OpenTelemetry.Meters.Server.General.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.general.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.Server.General.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersservergeneralenabled) * **ravendb.server.requests** Description: Exposes information about requests processed by server Enabled by default: _true_ - Configuration key: [Monitoring.OpenTelemetry.Meters.Server.Requests.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.requests.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.Server.Requests.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersserverrequestsenabled) * **ravendb.server.resources** Description: Exposes detailed information about resources usage (e.g. CPU etc.) Enabled by default: _true_ - Configuration key: [Monitoring.OpenTelemetry.Meters.Server.Resources.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.resources.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.Server.Resources.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersserverresourcesenabled) * **ravendb.server.storage** Description: Exposes storage information Enabled by default: _true_ - Configuration key: [Monitoring.OpenTelemetry.Meters.Server.Storage.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.storage.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.Server.Storage.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersserverstorageenabled) * **ravendb.server.totaldatabases** Description: Exposes aggregated information about databases on the server Enabled by default: _true_ - Configuration key: [Monitoring.OpenTelemetry.Meters.Server.TotalDatabases.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.totaldatabases.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.Server.TotalDatabases.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersservertotaldatabasesenabled) RavenDB also supports exposing meters developed by Microsoft for AspNetCore and .NET Runtime: * **Official AspNetCore instrumentation** Description: See the official MS documentation [AspNetCore documentation](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/main/src/OpenTelemetry.Instrumentation.AspNetCore/README.md#metrics) Enabled by default: _false_ - Configuration key: [Monitoring.OpenTelemetry.Meters.AspNetCore.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.aspnetcore.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.AspNetCore.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersaspnetcoreenabled) * **Official Runtime instrumentation** Description: See the official MS documentation [.NET Runtime documentation](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/tree/main/src/OpenTelemetry.Instrumentation.Runtime#metrics) Enabled by default: _false_ - Configuration key: [Monitoring.OpenTelemetry.Meters.Runtime.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.runtime.enabled) + Configuration key: [Monitoring.OpenTelemetry.Meters.Runtime.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetrymetersruntimeenabled) @@ -112,7 +112,7 @@ RavenDB also supports exposing meters developed by Microsoft for AspNetCore and * The server instance identification is determined by the following sequence: 1. **Configuration Key** - First, attempt to retrieve the [Monitoring.OpenTelemetry.ServiceInstanceId](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.serviceinstanceid) configuration key. + First, attempt to retrieve the [Monitoring.OpenTelemetry.ServiceInstanceId](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryserviceinstanceid) configuration key. 2. **Public URL Hostname** If the configuration key is Not defined, use the server's public URL hostname, provided it is available. 3. **Node Tag** @@ -257,7 +257,7 @@ RavenDB offers two options for exporting metrics: as it eliminates the need for integration with external monitoring systems or observability platforms. * To enable output to the console - - set the [Monitoring.OpenTelemetry.ConsoleExporter](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.consoleexporter) configuration key to _true_. + set the [Monitoring.OpenTelemetry.ConsoleExporter](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryconsoleexporter) configuration key to _true_. @@ -274,18 +274,18 @@ RavenDB offers two options for exporting metrics: * RavenDB supports the official OTLP by default, allowing you to export RavenDB metrics to the OpenTelemetry Collector. * To enable exporting metrics via the OpenTelemetry Protocol - - set the [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.enabled) configuration key to _true_. + set the [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocolenabled) configuration key to _true_. * By default, RavenDB does not override the OpenTelemetry Protocol exporter default values. However, customization is available via the following configuration options: | Configuration key | Description | Accepted values | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| -| Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.ExportProcessorType](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.exportprocessortype) | Export processor type | Simple / Batch | -| Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Headers](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.headers) | Custom headers | string | -| Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Protocol](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.protocol) | Defines the transport protocol that OpenTelemetry Protocol should use to send data. | gRPC / HttpProtobuf | -| Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Endpoint](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.endpoint) | Endpoint where OpenTelemetry Protocol should send data.
See configuration details [below](../../../server/administration/monitoring/open-telemetry.mdx#configure-endpoint). | string | -| Monitoring.OpenTelemetry.OpenTelemetryProtocol
[.Timeout](../../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.timeout) | Timeout | int | +| 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
[.Timeout](../../../server/configuration/monitoring-configuration.mdx#monitoringopentelemetryopentelemetryprotocoltimeout) | Timeout | int | diff --git a/versioned_docs/version-7.0/server/administration/snmp/snmp-overview.mdx b/versioned_docs/version-7.0/server/administration/snmp/snmp-overview.mdx index 84621a9a7a..804007342b 100644 --- a/versioned_docs/version-7.0/server/administration/snmp/snmp-overview.mdx +++ b/versioned_docs/version-7.0/server/administration/snmp/snmp-overview.mdx @@ -63,7 +63,7 @@ SNMP support is available for [Enterprise](../../../start/licensing/licensing-ov ## Enabling SNMP in RavenDB -* To monitor RavenDB using SNMP you __must__ first set the [Monitoring.Snmp.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.enabled) configuration key to _true_. +* To monitor RavenDB using SNMP you __must__ first set the [Monitoring.Snmp.Enabled](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpenabled) configuration key to _true_. * To learn how to modify a configuration key, refer to the [Configuration Overview](../../../server/configuration/configuration-options.mdx) article, which outlines all available options. @@ -88,36 +88,36 @@ SNMP support is available for [Enterprise](../../../start/licensing/licensing-ov There are several configurable SNMP properties in RavenDB: ##### For SNMPv1: -* [Monitoring.Snmp.Port](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.port) +* [Monitoring.Snmp.Port](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpport) The SNMP port. Default: `161` -* [Monitoring.Snmp.SupportedVersions](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.supportedversions) +* [Monitoring.Snmp.SupportedVersions](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpsupportedversions) List of supported SNMP versions. Default: `"V2C;V3"` ##### For SNMPv2c: -* [Monitoring.Snmp.Community](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.community) +* [Monitoring.Snmp.Community](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpcommunity) The community string is used as a password. It is sent with each SNMP `GET` request and allows or denies access to the monitored device. Default: `"ravendb"` ##### For SNMPv3: -* [Monitoring.Snmp.AuthenticationProtocol](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationprotocol) +* [Monitoring.Snmp.AuthenticationProtocol](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationprotocol) Authentication protocol. Default: `"SHA1"` -* [Monitoring.Snmp.AuthenticationUser](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationuser) +* [Monitoring.Snmp.AuthenticationUser](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationuser) The user for authentication. Default: `"ravendb"` -* [Monitoring.Snmp.AuthenticationPassword](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationpassword) +* [Monitoring.Snmp.AuthenticationPassword](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpauthenticationpassword) The authentication password. When set to `null` the community string is used instead. Default: `null` -* [Monitoring.Snmp.PrivacyProtocol](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.privacyprotocol) +* [Monitoring.Snmp.PrivacyProtocol](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpprivacyprotocol) Privacy protocol. Default: `None` -* [Monitoring.Snmp.PrivacyPassword](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.privacypassword) +* [Monitoring.Snmp.PrivacyPassword](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpprivacypassword) Privacy password. Default: `"ravendb"` @@ -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#1.3). + 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 SNMPv2c: @@ -166,7 +166,7 @@ iso.3.6.1.4.1.45751.1.1.1.3 = Timeticks: (29543973) 3 days, 10:03:59.73 - * `ravendb` is the community string (set via the [Monitoring.Snmp.Community](../../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.community) configuration key). + * `ravendb` is the community string (set via the [Monitoring.Snmp.Community](../../../server/configuration/monitoring-configuration.mdx#monitoringsnmpcommunity) configuration key). * `"live-test.ravendb.net"` is the host. ##### For SNMPv3: @@ -195,7 +195,7 @@ __Access single OID value__: * 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#1.3): +* For example, a cURL request for the server [up-time metric](../../../server/administration/snmp/snmp-overview.mdx#13): @@ -212,7 +212,7 @@ __Access multiple OID values__: * 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#1.6.7) and [unmanaged memory](../../../server/administration/snmp/snmp-overview.mdx#1.6.8) metrics: +* 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: diff --git a/versioned_docs/version-7.0/server/clustering/distribution/cluster-observer.mdx b/versioned_docs/version-7.0/server/clustering/distribution/cluster-observer.mdx index 682ee0755e..44d14439b6 100644 --- a/versioned_docs/version-7.0/server/clustering/distribution/cluster-observer.mdx +++ b/versioned_docs/version-7.0/server/clustering/distribution/cluster-observer.mdx @@ -30,8 +30,8 @@ import LanguageContent from "@site/src/components/LanguageContent"; * To maintain the Replication Factor, every newly elected [Leader](../../../server/clustering/rachis/cluster-topology.mdx#leader) starts measuring the health of each node by creating dedicated maintenance TCP connections to all other nodes in the cluster. -* Each node reports the current status of _all_ its databases at intervals of [500 milliseconds](../../../server/configuration/cluster-configuration.mdx#cluster.workersampleperiodinms) (by default). - The `Cluster Observer` consumes those reports every [1000 milliseconds](../../../server/configuration/cluster-configuration.mdx#cluster.supervisorsampleperiodinms) (by default). +* Each node reports the current status of _all_ its databases at intervals of [500 milliseconds](../../../server/configuration/cluster-configuration.mdx#clusterworkersampleperiodinms) (by default). + The `Cluster Observer` consumes those reports every [1000 milliseconds](../../../server/configuration/cluster-configuration.mdx#clustersupervisorsampleperiodinms) (by default). * Upon a **node failure**, the [Dynamic Database Distribution](../../../server/clustering/distribution/distributed-database.mdx#dynamic-database-distribution) sequence will take place in order to ensure that the `Replication Factor` does not change. @@ -49,11 +49,11 @@ import LanguageContent from "@site/src/components/LanguageContent"; * If node C goes offline or becomes unreachable, the Cluster Observer detects the issue. Initially: - * After the duration specified in the [Cluster.TimeBeforeMovingToRehabInSec](../../../server/configuration/cluster-configuration.mdx#cluster.timebeforemovingtorehabinsec) configuration, + * After the duration specified in the [Cluster.TimeBeforeMovingToRehabInSec](../../../server/configuration/cluster-configuration.mdx#clustertimebeforemovingtorehabinsec) configuration, the observer moves node C to rehab mode, allowing time for recovery. * The ETL task fails over to another available node in the Database Group. - * If node C remains offline beyond the period specified in the [Cluster.TimeBeforeAddingReplicaInSec](../../../server/configuration/cluster-configuration.mdx#cluster.timebeforeaddingreplicainsec) configuration, + * If node C remains offline beyond the period specified in the [Cluster.TimeBeforeAddingReplicaInSec](../../../server/configuration/cluster-configuration.mdx#clustertimebeforeaddingreplicainsec) configuration, the observer begins replicating the database to another node in the Database Group as a last resort. diff --git a/versioned_docs/version-7.0/server/clustering/distribution/distributed-database.mdx b/versioned_docs/version-7.0/server/clustering/distribution/distributed-database.mdx index 527c60e3d8..bb6aeb9415 100644 --- a/versioned_docs/version-7.0/server/clustering/distribution/distributed-database.mdx +++ b/versioned_docs/version-7.0/server/clustering/distribution/distributed-database.mdx @@ -101,10 +101,10 @@ All `Members` have master-master [Replication](../../../server/clustering/replic If any of the `Database Nodes` is down or partitioned, the [Cluster Observer](../../../server/clustering/distribution/cluster-observer.mdx) will recognize it and act as follows: -1. If the time that is defined in [TimeBeforeMovingToRehabInSec](../../../server/configuration/cluster-configuration.mdx#cluster.timebeforemovingtorehabinsec) (default: 60 seconds) has passed +1. If the time that is defined in [TimeBeforeMovingToRehabInSec](../../../server/configuration/cluster-configuration.mdx#clustertimebeforemovingtorehabinsec) (default: 60 seconds) has passed and the node is still unreachable, the node will be moved to a `Rehab` state. -2. If the node remains in `Rehab` for the time defined in [TimeBeforeAddingReplicaInSec](../../../server/configuration/cluster-configuration.mdx#cluster.timebeforeaddingreplicainsec) (default: 900 seconds), +2. If the node remains in `Rehab` for the time defined in [TimeBeforeAddingReplicaInSec](../../../server/configuration/cluster-configuration.mdx#clustertimebeforeaddingreplicainsec) (default: 900 seconds), a new database node will be automatically added to the database group to replace the `Rehab` node. 3. If the `Rehab` node is online again, it will be assigned a [Mentor Node](../../../server/clustering/distribution/highly-available-tasks.mdx#responsible-node) to update it with the recent changes. diff --git a/versioned_docs/version-7.0/server/clustering/distribution/highly-available-tasks.mdx b/versioned_docs/version-7.0/server/clustering/distribution/highly-available-tasks.mdx index 3aeaa0a193..c0625bcdf3 100644 --- a/versioned_docs/version-7.0/server/clustering/distribution/highly-available-tasks.mdx +++ b/versioned_docs/version-7.0/server/clustering/distribution/highly-available-tasks.mdx @@ -129,7 +129,7 @@ The failover of a task to another responsible node can be prevented by **pinning * If the node the task is pinned to fails, the task will **not** be executed until the node is back online. When the node awakes, the task will be resumed from the failure point on. * If a node remains offline for the period set by - [cluster.timebeforeaddingreplicainsec](../../../server/configuration/cluster-configuration.mdx#cluster.timebeforeaddingreplicainsec), + [cluster.timebeforeaddingreplicainsec](../../../server/configuration/cluster-configuration.mdx#clustertimebeforeaddingreplicainsec), the cluster observer will attempt to select an available node to replace it in the database group and redistribute the fallen node's tasks, including pinned ones, among database group members. A task can be pinned to a selected node via Studio or using code. diff --git a/versioned_docs/version-7.0/server/configuration/ai-integration-configuration.mdx b/versioned_docs/version-7.0/server/configuration/ai-integration-configuration.mdx index a435228686..c68ac00e2d 100644 --- a/versioned_docs/version-7.0/server/configuration/ai-integration-configuration.mdx +++ b/versioned_docs/version-7.0/server/configuration/ai-integration-configuration.mdx @@ -21,9 +21,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * When performing vector search queries, embeddings are also generated from the search term to compare against the stored vectors. * In this article: - * [Ai.Embeddings.MaxBatchSize](../../server/configuration/ai-integration-configuration.mdx#ai.embeddings.maxbatchsize) - * [Ai.Embeddings.MaxConcurrentBatches](../../server/configuration/ai-integration-configuration.mdx#ai.embeddings.maxconcurrentbatches) - * [Ai.Embeddings.MaxFallbackTimeInSec](../../server/configuration/ai-integration-configuration.mdx#ai.embeddings.maxfallbacktimeinsec) + * [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.Embeddings.MaxBatchSize diff --git a/versioned_docs/version-7.0/server/configuration/backup-configuration.mdx b/versioned_docs/version-7.0/server/configuration/backup-configuration.mdx index fc12abe0c9..a9491c3801 100644 --- a/versioned_docs/version-7.0/server/configuration/backup-configuration.mdx +++ b/versioned_docs/version-7.0/server/configuration/backup-configuration.mdx @@ -17,16 +17,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Configuration options for backups (both on premise and RavenDB Cloud). -* Another relevant server configuration option can be found [here](../../server/configuration/server-configuration.mdx#server.cpucredits.exhaustionbackupdelayinmin). +* 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#backup.temppath) - * [Backup.LocalRootPath](../../server/configuration/backup-configuration.mdx#backup.localrootpath) - * [Backup.AllowedDestinations](../../server/configuration/backup-configuration.mdx#backup.alloweddestinations) - * [Backup.AllowedAwsRegions](../../server/configuration/backup-configuration.mdx#backup.allowedawsregions) - * [Backup.MaxNumberOfConcurrentBackups](../../server/configuration/backup-configuration.mdx#backup.maxnumberofconcurrentbackups) - * [Backup.ConcurrentBackupsDelayInSec](../../server/configuration/backup-configuration.mdx#backup.concurrentbackupsdelayinsec) - * [Backup.LowMemoryBackupDelayInMin](../../server/configuration/backup-configuration.mdx#backup.lowmemorybackupdelayinmin) + * [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.TempPath diff --git a/versioned_docs/version-7.0/server/configuration/cluster-configuration.mdx b/versioned_docs/version-7.0/server/configuration/cluster-configuration.mdx index d2ccb1a07c..33f4068e4f 100644 --- a/versioned_docs/version-7.0/server/configuration/cluster-configuration.mdx +++ b/versioned_docs/version-7.0/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#cluster.compareexchangeexpireddeletefrequencyinsec) - [Cluster.CompareExchangeTombstonesCleanupIntervalInMin](../../server/configuration/cluster-configuration.mdx#cluster.compareexchangetombstonescleanupintervalinmin) - [Cluster.ElectionTimeoutInMs](../../server/configuration/cluster-configuration.mdx#cluster.electiontimeoutinms) - [Cluster.HardDeleteOnReplacement](../../server/configuration/cluster-configuration.mdx#cluster.harddeleteonreplacement) - [Cluster.LogHistoryMaxEntries](../../server/configuration/cluster-configuration.mdx#cluster.loghistorymaxentries) - [Cluster.MaxChangeVectorDistance](../../server/configuration/cluster-configuration.mdx#cluster.maxchangevectordistance) - [Cluster.MaxClusterTransactionCompareExchangeTombstoneCheckIntervalInMin](../../server/configuration/cluster-configuration.mdx#cluster.maxclustertransactioncompareexchangetombstonecheckintervalinmin) - [Cluster.MaxSizeOfSingleRaftCommandInMb](../../server/configuration/cluster-configuration.mdx#cluster.maxsizeofsingleraftcommandinmb) - [Cluster.MaximalAllowedClusterVersion](../../server/configuration/cluster-configuration.mdx#cluster.maximalallowedclusterversion) - [Cluster.OnErrorDelayTimeInMs](../../server/configuration/cluster-configuration.mdx#cluster.onerrordelaytimeinms) - [Cluster.OperationTimeoutInSec](../../server/configuration/cluster-configuration.mdx#cluster.operationtimeoutinsec) - [Cluster.ReceiveFromWorkerTimeoutInMs](../../server/configuration/cluster-configuration.mdx#cluster.receivefromworkertimeoutinms) - [Cluster.StatsStabilizationTimeInSec](../../server/configuration/cluster-configuration.mdx#cluster.statsstabilizationtimeinsec) - [Cluster.SupervisorSamplePeriodInMs](../../server/configuration/cluster-configuration.mdx#cluster.supervisorsampleperiodinms) - [Cluster.TcpReceiveBufferSizeInBytes](../../server/configuration/cluster-configuration.mdx#cluster.tcpreceivebuffersizeinbytes) - [Cluster.TcpSendBufferSizeInBytes](../../server/configuration/cluster-configuration.mdx#cluster.tcpsendbuffersizeinbytes) - [Cluster.TcpTimeoutInMs](../../server/configuration/cluster-configuration.mdx#cluster.tcptimeoutinms) - [Cluster.TimeBeforeAddingReplicaInSec](../../server/configuration/cluster-configuration.mdx#cluster.timebeforeaddingreplicainsec) - [Cluster.TimeBeforeMovingToRehabInSec](../../server/configuration/cluster-configuration.mdx#cluster.timebeforemovingtorehabinsec) - [Cluster.TimeBeforeRotatingPreferredNodeInSec](../../server/configuration/cluster-configuration.mdx#cluster.timebeforerotatingpreferrednodeinsec) - [Cluster.WorkerSamplePeriodInMs](../../server/configuration/cluster-configuration.mdx#cluster.workersampleperiodinms) + [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) * Server-wide, or database scope: - [Cluster.DisableAtomicDocumentWrites](../../server/configuration/cluster-configuration.mdx#cluster.disableatomicdocumentwrites) - [Cluster.MaxClusterTransactionBatchSize](../../server/configuration/cluster-configuration.mdx#cluster.maxclustertransactionbatchsize) + [Cluster.DisableAtomicDocumentWrites](../../server/configuration/cluster-configuration.mdx#clusterdisableatomicdocumentwrites) + [Cluster.MaxClusterTransactionBatchSize](../../server/configuration/cluster-configuration.mdx#clustermaxclustertransactionbatchsize) ## Cluster.CompareExchangeExpiredDeleteFrequencyInSec diff --git a/versioned_docs/version-7.0/server/configuration/configuration-options.mdx b/versioned_docs/version-7.0/server/configuration/configuration-options.mdx index 41d4b879da..9b8932b1bf 100644 --- a/versioned_docs/version-7.0/server/configuration/configuration-options.mdx +++ b/versioned_docs/version-7.0/server/configuration/configuration-options.mdx @@ -20,7 +20,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * 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#settings.json) + * [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) @@ -36,7 +36,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * The server will retrieve these environment variables and apply their values. -To set the [Security.Certificate.Path](../../server/configuration/security-configuration.mdx#security.certificate.path) +To set the [Security.Certificate.Path](../../server/configuration/security-configuration.mdx#securitycertificatepath) configuration key using an environment variable, add the environment variable `RAVEN_Security_Certificate_Path`. @@ -84,7 +84,7 @@ _settings.json_ configuration values **override** their matching Configuration options that include multiple values (like strings separated by `;`) can be configured using regular JSON arrays. -To set [Security.WellKnownCertificates.Admin](../../server/configuration/security-configuration.mdx#security.wellknowncertificates.admin), +To set [Security.WellKnownCertificates.Admin](../../server/configuration/security-configuration.mdx#securitywellknowncertificatesadmin), for example, use: @@ -104,7 +104,7 @@ 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#settings.json) values. +and [settings.json](../../server/configuration/configuration-options.mdx#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.0/server/configuration/core-configuration.mdx b/versioned_docs/version-7.0/server/configuration/core-configuration.mdx index d91c0fcf2d..67534168b9 100644 --- a/versioned_docs/version-7.0/server/configuration/core-configuration.mdx +++ b/versioned_docs/version-7.0/server/configuration/core-configuration.mdx @@ -14,7 +14,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; # Configuration: Core -[settings.json](../../server/configuration/configuration-options.mdx#settings.json) variables change your server's behavior in various ways. +[settings.json](../../server/configuration/configuration-options.mdx#settingsjson) variables change your server's behavior in various ways. RavenDB reads `settings.json` only during startup. @@ -283,7 +283,7 @@ The URLs which the server should contact when requesting certificates from using ## Features.Availability -This [settings.json](../../server/configuration/configuration-options.mdx#settings.json) variable determines whether to run RavenDB with its standard +This [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) variable determines whether to run RavenDB with its standard features set, or add to a set of experimental features. Some features, like ones recently released, are considered **experimental**. They are disabled by default, you can enable them by setting `Features.Availability` to `Experimental`. diff --git a/versioned_docs/version-7.0/server/configuration/database-configuration.mdx b/versioned_docs/version-7.0/server/configuration/database-configuration.mdx index 3ce2e86d4c..1838a18f08 100644 --- a/versioned_docs/version-7.0/server/configuration/database-configuration.mdx +++ b/versioned_docs/version-7.0/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#databases.compression.compressallcollectionsdefault) - [Databases.Compression.CompressRevisionsDefault](../../server/configuration/database-configuration.mdx#databases.compression.compressrevisionsdefault) - [Databases.ConcurrentLoadTimeoutInSec](../../server/configuration/database-configuration.mdx#databases.concurrentloadtimeoutinsec) - [Databases.FrequencyToCheckForIdleInSec](../../server/configuration/database-configuration.mdx#databases.frequencytocheckforidleinsec) - [Databases.MaxConcurrentLoads](../../server/configuration/database-configuration.mdx#databases.maxconcurrentloads) + [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) * Server-wide, or database scope: - [Databases.CollectionOperationTimeoutInSec](../../server/configuration/database-configuration.mdx#databases.collectionoperationtimeoutinsec) - [Databases.DeepCleanupThresholdInMin](../../server/configuration/database-configuration.mdx#databases.deepcleanupthresholdinmin) - [Databases.MaxIdleTimeInSec](../../server/configuration/database-configuration.mdx#databases.maxidletimeinsec) - [Databases.OperationTimeoutInSec](../../server/configuration/database-configuration.mdx#databases.operationtimeoutinsec) - [Databases.PulseReadTransactionLimitInMb](../../server/configuration/database-configuration.mdx#databases.pulsereadtransactionlimitinmb) - [Databases.QueryOperationTimeoutInSec](../../server/configuration/database-configuration.mdx#databases.queryoperationtimeoutinsec) - [Databases.QueryTimeoutInSec](../../server/configuration/database-configuration.mdx#databases.querytimeoutinsec) - [Databases.RegularCleanupThresholdInMin](../../server/configuration/database-configuration.mdx#databases.regularcleanupthresholdinmin) + [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.Compression.CompressAllCollectionsDefault diff --git a/versioned_docs/version-7.0/server/configuration/etl-configuration.mdx b/versioned_docs/version-7.0/server/configuration/etl-configuration.mdx index a34ded7c80..0c8fbbb5b3 100644 --- a/versioned_docs/version-7.0/server/configuration/etl-configuration.mdx +++ b/versioned_docs/version-7.0/server/configuration/etl-configuration.mdx @@ -16,16 +16,16 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [ETL.ExtractAndTransformTimeoutInSec](../../server/configuration/etl-configuration.mdx#etl.extractandtransformtimeoutinsec) - * [ETL.MaxBatchSizeInMb](../../server/configuration/etl-configuration.mdx#etl.maxbatchsizeinmb) - * [ETL.MaxFallbackTimeInSec](../../server/configuration/etl-configuration.mdx#etl.maxfallbacktimeinsec) - * [ETL.MaxNumberOfExtractedDocuments](../../server/configuration/etl-configuration.mdx#etl.maxnumberofextracteddocuments) - * [ETL.MaxNumberOfExtractedItems](../../server/configuration/etl-configuration.mdx#etl.maxnumberofextracteditems) - * [ETL.OLAP.MaxNumberOfExtractedDocuments](../../server/configuration/etl-configuration.mdx#etl.olap.maxnumberofextracteddocuments) - * [ETL.Queue.AzureQueueStorage.TimeToLiveInSec](../../server/configuration/etl-configuration.mdx#etl.queue.azurequeuestorage.timetoliveinsec) - * [ETL.Queue.AzureQueueStorage.VisibilityTimeoutInSec](../../server/configuration/etl-configuration.mdx#etl.queue.azurequeuestorage.visibilitytimeoutinsec) - * [ETL.Queue.Kafka.InitTransactionsTimeoutInSec](../../server/configuration/etl-configuration.mdx#etl.queue.kafka.inittransactionstimeoutinsec) - * [ETL.SQL.CommandTimeoutInSec](../../server/configuration/etl-configuration.mdx#etl.sql.commandtimeoutinsec) + * [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.SQL.CommandTimeoutInSec](../../server/configuration/etl-configuration.mdx#etlsqlcommandtimeoutinsec) ## ETL.ExtractAndTransformTimeoutInSec diff --git a/versioned_docs/version-7.0/server/configuration/http-configuration.mdx b/versioned_docs/version-7.0/server/configuration/http-configuration.mdx index 2085ce0028..056dc50221 100644 --- a/versioned_docs/version-7.0/server/configuration/http-configuration.mdx +++ b/versioned_docs/version-7.0/server/configuration/http-configuration.mdx @@ -20,28 +20,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#http.mindataratebytespersec) - * [Http.MinDataRateGracePeriodInSec](../../server/configuration/http-configuration.mdx#http.mindatarategraceperiodinsec) - * [Http.MaxRequestBufferSizeInKb](../../server/configuration/http-configuration.mdx#http.maxrequestbuffersizeinkb) - * [Http.MaxRequestLineSizeInKb](../../server/configuration/http-configuration.mdx#http.maxrequestlinesizeinkb) - * [Http.Http2.KeepAlivePingTimeoutInSec](../../server/configuration/http-configuration.mdx#http.http2.keepalivepingtimeoutinsec) - * [Http.Http2.KeepAlivePingDelayInSec](../../server/configuration/http-configuration.mdx#http.http2.keepalivepingdelayinsec) - * [Http.Http2.MaxStreamsPerConnection](../../server/configuration/http-configuration.mdx#http.http2.maxstreamsperconnection) - * [Http.UseResponseCompression](../../server/configuration/http-configuration.mdx#http.useresponsecompression) - * [Http.AllowResponseCompressionOverHttps](../../server/configuration/http-configuration.mdx#http.allowresponsecompressionoverhttps) - * [Http.GzipResponseCompressionLevel](../../server/configuration/http-configuration.mdx#http.gzipresponsecompressionlevel) - * [Http.DeflateResponseCompressionLevel](../../server/configuration/http-configuration.mdx#http.deflateresponsecompressionlevel) - * [Http.ZstdResponseCompressionLevel](../../server/configuration/http-configuration.mdx#http.zstdresponsecompressionlevel) - * [Http.StaticFilesResponseCompressionLevel](../../server/configuration/http-configuration.mdx#http.staticfilesresponsecompressionlevel) - * [Http.Protocols](../../server/configuration/http-configuration.mdx#http.protocols) - * [Http.AllowSynchronousIO](../../server/configuration/http-configuration.mdx#http.allowsynchronousio) + * [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 * 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#http.mindatarategraceperiodinsec). +* This option must be configured together with [Http.MinDataRateGracePeriod](../../server/configuration/http-configuration.mdx#httpmindatarategraceperiodinsec). - **Type**: `int` - **Default**: `null` - **Scope**: Server-wide only @@ -54,7 +54,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#http.mindataratebytespersec) + This option must be configured together with [Http.MinDataRateBytesPerSec](../../server/configuration/http-configuration.mdx#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.0/server/configuration/indexing-configuration.mdx b/versioned_docs/version-7.0/server/configuration/indexing-configuration.mdx index 9c038517ab..dd8f3e8264 100644 --- a/versioned_docs/version-7.0/server/configuration/indexing-configuration.mdx +++ b/versioned_docs/version-7.0/server/configuration/indexing-configuration.mdx @@ -26,88 +26,88 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this article: * Server-wide scope: - [Indexing.CleanupIntervalInMin](../../server/configuration/indexing-configuration.mdx#indexing.cleanupintervalinmin) - [Indexing.Corax.VectorSearch.MaxNumberOfThreadsForLocalEmbeddingsGeneration](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.maxnumberofthreadsforlocalembeddingsgeneration) - [Indexing.GlobalScratchSpaceLimitInMb](../../server/configuration/indexing-configuration.mdx#indexing.globalscratchspacelimitinmb) - [Indexing.MaxNumberOfConcurrentlyRunningIndexes](../../server/configuration/indexing-configuration.mdx#indexing.maxnumberofconcurrentlyrunningindexes) - [Indexing.MaxTimeToWaitAfterFlushAndSyncWhenExceedingScratchSpaceLimitInSec](../../server/configuration/indexing-configuration.mdx#indexing.maxtimetowaitafterflushandsyncwhenexceedingscratchspacelimitinsec) - [Indexing.NuGetAllowPreReleasePackages](../../server/configuration/indexing-configuration.mdx#indexing.nugetallowprereleasepackages) - [Indexing.NuGetPackageSourceUrl](../../server/configuration/indexing-configuration.mdx#indexing.nugetpackagesourceurl) - [Indexing.NuGetPackagesPath](../../server/configuration/indexing-configuration.mdx#indexing.nugetpackagespath) - [Indexing.QueryClauseCache.ExpirationScanFrequencyInSec](../../server/configuration/indexing-configuration.mdx#indexing.queryclausecache.expirationscanfrequencyinsec) - [Indexing.QueryClauseCache.RepeatedQueriesCount](../../server/configuration/indexing-configuration.mdx#indexing.queryclausecache.repeatedqueriescount) - [Indexing.QueryClauseCache.SizeInMb](../../server/configuration/indexing-configuration.mdx#indexing.queryclausecache.sizeinmb) + [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) * Server-wide, or database scope: - [Indexing.Auto.ArchivedDataProcessingBehavior](../../server/configuration/indexing-configuration.mdx#indexing.auto.archiveddataprocessingbehavior) - [Indexing.Auto.DeploymentMode](../../server/configuration/indexing-configuration.mdx#indexing.auto.deploymentmode) - [Indexing.Auto.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexing.auto.searchenginetype) - [Indexing.Disable](../../server/configuration/indexing-configuration.mdx#indexing.disable) - [Indexing.DisableQueryOptimizerGeneratedIndexes](../../server/configuration/indexing-configuration.mdx#indexing.disablequeryoptimizergeneratedindexes) - [Indexing.ErrorIndexStartupBehavior](../../server/configuration/indexing-configuration.mdx#indexing.errorindexstartupbehavior) - [Indexing.History.NumberOfRevisions](../../server/configuration/indexing-configuration.mdx#indexing.history.numberofrevisions) - [Indexing.IndexStartupBehavior](../../server/configuration/indexing-configuration.mdx#indexing.indexstartupbehavior) - [Indexing.ResetMode](../../server/configuration/indexing-configuration.mdx#indexing.resetmode) - [Indexing.RunInMemory](../../server/configuration/indexing-configuration.mdx#indexing.runinmemory) - [Indexing.SkipDatabaseIdValidationOnIndexOpening](../../server/configuration/indexing-configuration.mdx#indexing.skipdatabaseidvalidationonindexopening) - [Indexing.Static.ArchivedDataProcessingBehavior](../../server/configuration/indexing-configuration.mdx#indexing.static.archiveddataprocessingbehavior) - [Indexing.Static.DeploymentMode](../../server/configuration/indexing-configuration.mdx#indexing.static.deploymentmode) - [Indexing.Static.RequireAdminToDeployJavaScriptIndexes](../../server/configuration/indexing-configuration.mdx#indexing.static.requireadmintodeployjavascriptindexes) - [Indexing.TempPath](../../server/configuration/indexing-configuration.mdx#indexing.temppath) - [Indexing.TimeBeforeDeletionOfSupersededAutoIndexInSec](../../server/configuration/indexing-configuration.mdx#indexing.timebeforedeletionofsupersededautoindexinsec) - [Indexing.TimeToWaitBeforeDeletingAutoIndexMarkedAsIdleInHrs](../../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforedeletingautoindexmarkedasidleinhrs) - [Indexing.TimeToWaitBeforeMarkingAutoIndexAsIdleInMin](../../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforemarkingautoindexasidleinmin) + [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) * Server-wide, or database, or per index: - [Indexing.AllowStringCompilation](../../server/configuration/indexing-configuration.mdx#indexing.allowstringcompilation) - [Indexing.Analyzers.Default](../../server/configuration/indexing-configuration.mdx#indexing.analyzers.default) - [Indexing.Analyzers.Exact.Default](../../server/configuration/indexing-configuration.mdx#indexing.analyzers.exact.default) - [Indexing.Analyzers.Search.Default](../../server/configuration/indexing-configuration.mdx#indexing.analyzers.search.default) - [Indexing.Corax.DocumentsLimitForCompressionDictionaryCreation](../../server/configuration/indexing-configuration.mdx#indexing.corax.documentslimitforcompressiondictionarycreation) - [Indexing.Corax.IncludeDocumentScore](../../server/configuration/indexing-configuration.mdx#indexing.corax.includedocumentscore) - [Indexing.Corax.IncludeSpatialDistance](../../server/configuration/indexing-configuration.mdx#indexing.corax.includespatialdistance) - [Indexing.Corax.MaxAllocationsAtDictionaryTrainingInMb](../../server/configuration/indexing-configuration.mdx#indexing.corax.maxallocationsatdictionarytraininginmb) - [Indexing.Corax.MaxMemoizationSizeInMb](../../server/configuration/indexing-configuration.mdx#indexing.corax.maxmemoizationsizeinmb) - [Indexing.Corax.Static.ComplexFieldIndexingBehavior](../../server/configuration/indexing-configuration.mdx#indexing.corax.static.complexfieldindexingbehavior) - [Indexing.Corax.UnmanagedAllocationsBatchSizeLimitInMb](../../server/configuration/indexing-configuration.mdx#indexing.corax.unmanagedallocationsbatchsizelimitinmb) - [Indexing.Corax.VectorSearch.DefaultMinimumSimilarity](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultminimumsimilarity) - [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForIndexing](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultnumberofcandidatesforindexing) - [Indexing.Corax.VectorSearch.DefaultNumberOfCandidatesForQuerying](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultnumberofcandidatesforquerying) - [Indexing.Corax.VectorSearch.DefaultNumberOfEdges](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.defaultnumberofedges) - [Indexing.Corax.VectorSearch.MaximumConcurrentBatchesForHnswAcceleration](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.maximumconcurrentbatchesforhnswacceleration) - [Indexing.Corax.VectorSearch.OrderByScoreAutomatically](../../server/configuration/indexing-configuration.mdx#indexing.corax.vectorsearch.orderbyscoreautomatically) - [Indexing.Encrypted.TransactionSizeLimitInMb](../../server/configuration/indexing-configuration.mdx#indexing.encrypted.transactionsizelimitinmb) - [Indexing.IndexEmptyEntries](../../server/configuration/indexing-configuration.mdx#indexing.indexemptyentries) - [Indexing.IndexMissingFieldsAsNull](../../server/configuration/indexing-configuration.mdx#indexing.indexmissingfieldsasnull) - [Indexing.Lucene.Analyzers.NGram.MaxGram](../../server/configuration/indexing-configuration.mdx#indexing.lucene.analyzers.ngram.maxgram) - [Indexing.Lucene.Analyzers.NGram.MinGram](../../server/configuration/indexing-configuration.mdx#indexing.lucene.analyzers.ngram.mingram) - [Indexing.Lucene.IndexInputType](../../server/configuration/indexing-configuration.mdx#indexing.lucene.indexinputtype) - [Indexing.Lucene.LargeSegmentSizeToMergeInMb](../../server/configuration/indexing-configuration.mdx#indexing.lucene.largesegmentsizetomergeinmb) - [Indexing.Lucene.MaximumSizePerSegmentInMb](../../server/configuration/indexing-configuration.mdx#indexing.lucene.maximumsizepersegmentinmb) - [Indexing.Lucene.MaxTimeForMergesToKeepRunningInSec](../../server/configuration/indexing-configuration.mdx#indexing.lucene.maxtimeformergestokeeprunninginsec) - [Indexing.Lucene.MergeFactor](../../server/configuration/indexing-configuration.mdx#indexing.lucene.mergefactor) - [Indexing.Lucene.NumberOfLargeSegmentsToMergeInSingleBatch](../../server/configuration/indexing-configuration.mdx#indexing.lucene.numberoflargesegmentstomergeinsinglebatch) - [Indexing.Lucene.ReaderTermsIndexDivisor](../../server/configuration/indexing-configuration.mdx#indexing.lucene.readertermsindexdivisor) - [Indexing.Lucene.UseCompoundFileInMerging](../../server/configuration/indexing-configuration.mdx#indexing.lucene.usecompoundfileinmerging) - [Indexing.ManagedAllocationsBatchSizeLimitInMb](../../server/configuration/indexing-configuration.mdx#indexing.managedallocationsbatchsizelimitinmb) - [Indexing.MapBatchSize](../../server/configuration/indexing-configuration.mdx#indexing.mapbatchsize) - [Indexing.MapTimeoutAfterEtagReachedInMin](../../server/configuration/indexing-configuration.mdx#indexing.maptimeoutafteretagreachedinmin) - [Indexing.MapTimeoutInSec](../../server/configuration/indexing-configuration.mdx#indexing.maptimeoutinsec) - [Indexing.MaxStepsForScript](../../server/configuration/indexing-configuration.mdx#indexing.maxstepsforscript) - [Indexing.MaxTimeForDocumentTransactionToRemainOpenInSec](../../server/configuration/indexing-configuration.mdx#indexing.maxtimefordocumenttransactiontoremainopeninsec) - [Indexing.MaxTimeToWaitAfterFlushAndSyncWhenReplacingSideBySideIndexInSec](../../server/configuration/indexing-configuration.mdx#indexing.maxtimetowaitafterflushandsyncwhenreplacingsidebysideindexinsec) - [Indexing.Metrics.Enabled](../../server/configuration/indexing-configuration.mdx#indexing.metrics.enabled) - [Indexing.MinNumberOfMapAttemptsAfterWhichBatchWillBeCanceledIfRunningLowOnMemory](../../server/configuration/indexing-configuration.mdx#indexing.minnumberofmapattemptsafterwhichbatchwillbecanceledifrunninglowonmemory) - [Indexing.MinimumTotalSizeOfJournalsToRunFlushAndSyncWhenReplacingSideBySideIndexInMb](../../server/configuration/indexing-configuration.mdx#indexing.minimumtotalsizeofjournalstorunflushandsyncwhenreplacingsidebysideindexinmb) - [Indexing.NumberOfConcurrentStoppedBatchesIfRunningLowOnMemory](../../server/configuration/indexing-configuration.mdx#indexing.numberofconcurrentstoppedbatchesifrunninglowonmemory) - [Indexing.NumberOfLargeSegmentsToMergeInSingleBatch](../../server/configuration/indexing-configuration.mdx#indexing.numberoflargesegmentstomergeinsinglebatch) - [Indexing.OrderByScoreAutomaticallyWhenBoostingIsInvolved](../../server/configuration/indexing-configuration.mdx#indexing.orderbyscoreautomaticallywhenboostingisinvolved) - [Indexing.OrderByTicksAutomaticallyWhenDatesAreInvolved](../../server/configuration/indexing-configuration.mdx#indexing.orderbyticksautomaticallywhendatesareinvolved) - [Indexing.QueryClauseCache.Disabled](../../server/configuration/indexing-configuration.mdx#indexing.queryclausecache.disabled) - [Indexing.QueryClauseCache.RepeatedQueriesTimeFrameInSec](../../server/configuration/indexing-configuration.mdx#indexing.queryclausecache.repeatedqueriestimeframeinsec) - [Indexing.ScratchSpaceLimitInMb](../../server/configuration/indexing-configuration.mdx#indexing.scratchspacelimitinmb) - [Indexing.Static.SearchEngineType](../../server/configuration/indexing-configuration.mdx#indexing.static.searchenginetype) - [Indexing.Throttling.TimeIntervalInMs](../../server/configuration/indexing-configuration.mdx#indexing.throttling.timeintervalinms) - [Indexing.TimeSinceLastQueryAfterWhichDeepCleanupCanBeExecutedInMin](../../server/configuration/indexing-configuration.mdx#indexing.timesincelastqueryafterwhichdeepcleanupcanbeexecutedinmin) - [Indexing.TransactionSizeLimitInMb](../../server/configuration/indexing-configuration.mdx#indexing.transactionsizelimitinmb) + [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.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.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.CleanupIntervalInMin @@ -724,7 +724,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#indexing.numberoflargesegmentstomergeinsinglebatch) in a single batch. + We won't merge more than [Indexing.NumberOfLargeSegmentsToMergeInSingleBatch](../../server/configuration/indexing-configuration.mdx#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` @@ -787,7 +787,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#indexing.largesegmentsizetomergeinmb) to merge in a single batch. +* Number of large segments defined by [Indexing.LargeSegmentSizeToMergeInMb](../../server/configuration/indexing-configuration.mdx#indexinglargesegmentsizetomergeinmb) to merge in a single batch. - **Type**: `int` - **Default**: `2` - **Scope**: Server-wide, or per database, or per index @@ -969,7 +969,7 @@ EXPERT ONLY: * Disable the query clause cache for a server, database, or a single index. * The default value is set by the constructor of class `IndexingConfiguration`. - It will be `true` if your core configuration key [Features.Availability](../../server/configuration/core-configuration.mdx#features.availability) is Not set to 'Experimental'. + It will be `true` if your core configuration key [Features.Availability](../../server/configuration/core-configuration.mdx#featuresavailability) is Not set to 'Experimental'. - **Type**: `bool` - **Default**: `DefaultValueSetInConstructor` - **Scope**: Server-wide, or per database, or per index diff --git a/versioned_docs/version-7.0/server/configuration/license-configuration.mdx b/versioned_docs/version-7.0/server/configuration/license-configuration.mdx index b2384a222c..2178f7f76c 100644 --- a/versioned_docs/version-7.0/server/configuration/license-configuration.mdx +++ b/versioned_docs/version-7.0/server/configuration/license-configuration.mdx @@ -118,7 +118,7 @@ Disable automatic updates of the license from the License Server (api.ravendb.ne 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#license.path) configuration +* Setting the [License.Path](../../server/configuration/license-configuration.mdx#licensepath) configuration * Replacing the _license.json_ file on disk - **Type**: `bool` - **Default**: `false` diff --git a/versioned_docs/version-7.0/server/configuration/logs-configuration.mdx b/versioned_docs/version-7.0/server/configuration/logs-configuration.mdx index cb2ede4ca1..8722b1c4f7 100644 --- a/versioned_docs/version-7.0/server/configuration/logs-configuration.mdx +++ b/versioned_docs/version-7.0/server/configuration/logs-configuration.mdx @@ -20,24 +20,24 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: * RavenDB logging configuration keys: - [Logs.ArchiveAboveSizeInMb](../../server/configuration/logs-configuration.mdx#logs.archiveabovesizeinmb) - [Logs.ConfigPath](../../server/configuration/logs-configuration.mdx#logs.configpath) - [Logs.EnableArchiveFileCompression](../../server/configuration/logs-configuration.mdx#logs.enablearchivefilecompression) - [Logs.MaxArchiveDays](../../server/configuration/logs-configuration.mdx#logs.maxarchivedays) - [Logs.MaxArchiveFiles](../../server/configuration/logs-configuration.mdx#logs.maxarchivefiles) - [Logs.Microsoft.MinLevel](../../server/configuration/logs-configuration.mdx#logs.microsoft.minlevel) - [Logs.MinLevel](../../server/configuration/logs-configuration.mdx#logs.minlevel) - [Logs.NuGet.AdditionalPackages](../../server/configuration/logs-configuration.mdx#logs.nuget.additionalpackages) - [Logs.NuGet.AllowPreReleasePackages](../../server/configuration/logs-configuration.mdx#logs.nuget.allowprereleasepackages) - [Logs.NuGet.PackagesPath](../../server/configuration/logs-configuration.mdx#logs.nuget.packagespath) - [Logs.NuGet.PackageSourceUrl](../../server/configuration/logs-configuration.mdx#logs.nuget.packagesourceurl) - [Logs.Path](../../server/configuration/logs-configuration.mdx#logs.path) - [Logs.ThrowConfigExceptions](../../server/configuration/logs-configuration.mdx#logs.throwconfigexceptions) + [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.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) * Internal NLog configuration keys: - [Logs.Internal.Level](../../server/configuration/logs-configuration.mdx#logs.internal.level) - [Logs.Internal.LogToStandardError](../../server/configuration/logs-configuration.mdx#logs.internal.logtostandarderror) - [Logs.Internal.LogToStandardOutput](../../server/configuration/logs-configuration.mdx#logs.internal.logtostandardoutput) - [Logs.Internal.Path](../../server/configuration/logs-configuration.mdx#logs.internal.path) + [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.ArchiveAboveSizeInMb diff --git a/versioned_docs/version-7.0/server/configuration/monitoring-configuration.mdx b/versioned_docs/version-7.0/server/configuration/monitoring-configuration.mdx index 309846e8ce..596e653626 100644 --- a/versioned_docs/version-7.0/server/configuration/monitoring-configuration.mdx +++ b/versioned_docs/version-7.0/server/configuration/monitoring-configuration.mdx @@ -17,45 +17,45 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: * OpenTelemetry monitoring: - [Monitoring.OpenTelemetry.ConsoleExporter](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.consoleexporter) - [Monitoring.OpenTelemetry.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.enabled) - [Monitoring.OpenTelemetry.Meters.AspNetCore.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.aspnetcore.enabled) - [Monitoring.OpenTelemetry.Meters.Runtime.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.runtime.enabled) - [Monitoring.OpenTelemetry.Meters.Server.CPUCredits.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.cpucredits.enabled) - [Monitoring.OpenTelemetry.Meters.Server.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.enabled) - [Monitoring.OpenTelemetry.Meters.Server.GC.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.gc.enabled) - [Monitoring.OpenTelemetry.Meters.Server.General.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.general.enabled) - [Monitoring.OpenTelemetry.Meters.Server.Requests.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.requests.enabled) - [Monitoring.OpenTelemetry.Meters.Server.Resources.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.resources.enabled) - [Monitoring.OpenTelemetry.Meters.Server.Storage.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.storage.enabled) - [Monitoring.OpenTelemetry.Meters.Server.TotalDatabases.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.meters.server.totaldatabases.enabled) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.enabled) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Endpoint](../..//server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.endpoint) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.ExportProcessorType](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.exportprocessortype) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Headers](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.headers) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Protocol](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.protocol) - [Monitoring.OpenTelemetry.OpenTelemetryProtocol.Timeout](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.opentelemetryprotocol.timeout) - [Monitoring.OpenTelemetry.ServiceInstanceId](../../server/configuration/monitoring-configuration.mdx#monitoring.opentelemetry.serviceinstanceid) + [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) * SNMP monitoring - [Monitoring.Snmp.AuthenticationPassword](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationpassword) - [Monitoring.Snmp.AuthenticationPassword.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationpassword.secondary) - [Monitoring.Snmp.AuthenticationProtocol](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationprotocol) - [Monitoring.Snmp.AuthenticationProtocol.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationprotocol.secondary) - [Monitoring.Snmp.AuthenticationUser](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationuser) - [Monitoring.Snmp.AuthenticationUser.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.authenticationuser.secondary) - [Monitoring.Snmp.Community](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.community) - [Monitoring.Snmp.DisableTimeWindowChecks](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.disabletimewindowchecks) - [Monitoring.Snmp.Enabled](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.enabled) - [Monitoring.Snmp.Port](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.port) - [Monitoring.Snmp.PrivacyPassword](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.privacypassword) - [Monitoring.Snmp.PrivacyPassword.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.privacypassword.secondary) - [Monitoring.Snmp.PrivacyProtocol](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.privacyprotocol) - [Monitoring.Snmp.PrivacyProtocol.Secondary](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.privacyprotocol.secondary) - [Monitoring.Snmp.SupportedVersions](../../server/configuration/monitoring-configuration.mdx#monitoring.snmp.supportedversions) + [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) * Other monitoring: - [Monitoring.Cpu.Exec](../../server/configuration/monitoring-configuration.mdx#monitoring.cpu.exec) - [Monitoring.Cpu.Exec.Arguments](../../server/configuration/monitoring-configuration.mdx#monitoring.cpu.exec.arguments) - [Monitoring.Disk.ReadStatsDebounceTimeInMs](../../server/configuration/monitoring-configuration.mdx#monitoring.disk.readstatsdebouncetimeinms) + [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.OpenTelemetry.ConsoleExporter diff --git a/versioned_docs/version-7.0/server/configuration/patching-configuration.mdx b/versioned_docs/version-7.0/server/configuration/patching-configuration.mdx index 0bfdd7512e..1639b36e61 100644 --- a/versioned_docs/version-7.0/server/configuration/patching-configuration.mdx +++ b/versioned_docs/version-7.0/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#patching.allowstringcompilation) - * [Patching.MaxStepsForScript](../../server/configuration/patching-configuration.mdx#patching.maxstepsforscript) - * [Patching.StrictMode](../../server/configuration/patching-configuration.mdx#patching.strictmode) + * [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 diff --git a/versioned_docs/version-7.0/server/configuration/performance-hints-configuration.mdx b/versioned_docs/version-7.0/server/configuration/performance-hints-configuration.mdx index 7cb37af2d3..ae8237050d 100644 --- a/versioned_docs/version-7.0/server/configuration/performance-hints-configuration.mdx +++ b/versioned_docs/version-7.0/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#performancehints.documents.hugedocumentscollectionsize) - * [PerformanceHints.Documents.HugeDocumentSizeInMb](../../server/configuration/performance-hints-configuration.mdx#performancehints.documents.hugedocumentsizeinmb) - * [PerformanceHints.Indexing.AlertWhenSourceDocumentIncludedInOutput](../../server/configuration/performance-hints-configuration.mdx#performancehints.indexing.alertwhensourcedocumentincludedinoutput) - * [PerformanceHints.Indexing.MaxDepthOfRecursionInLinqSelect](../../server/configuration/performance-hints-configuration.mdx#performancehints.indexing.maxdepthofrecursioninlinqselect) - * [PerformanceHints.Indexing.MaxIndexOutputsPerDocument](../../server/configuration/performance-hints-configuration.mdx#performancehints.indexing.maxindexoutputsperdocument) - * [PerformanceHints.Indexing.MaxNumberOfLoadsPerReference](../../server/configuration/performance-hints-configuration.mdx#performancehints.indexing.maxnumberofloadsperreference) - * [PerformanceHints.MaxNumberOfResults](../../server/configuration/performance-hints-configuration.mdx#performancehints.maxnumberofresults) - * [PerformanceHints.Memory.MinSwapSizeInMb](../../server/configuration/performance-hints-configuration.mdx#performancehints.memory.minswapsizeinmb) - * [PerformanceHints.TooLongRequestThresholdInSec](../../server/configuration/performance-hints-configuration.mdx#performancehints.toolongrequestthresholdinsec) + * [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 diff --git a/versioned_docs/version-7.0/server/configuration/queue-sink-configuration.mdx b/versioned_docs/version-7.0/server/configuration/queue-sink-configuration.mdx index 543abbf9a5..d551ff6821 100644 --- a/versioned_docs/version-7.0/server/configuration/queue-sink-configuration.mdx +++ b/versioned_docs/version-7.0/server/configuration/queue-sink-configuration.mdx @@ -18,7 +18,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; The maximum number of pulled messages consumed in a single batch. - **Default**: `8192` -- **Scope**: [Server-wide](../../server/configuration/configuration-options.mdx#settings.json) +- **Scope**: [Server-wide](../../server/configuration/configuration-options.mdx#settingsjson) or [per database](../../studio/database/settings/database-settings.mdx#view-database-settings) @@ -30,7 +30,7 @@ mode (i.e. suspending the process) after a connection failure. - **Default**: `15*60` - **TimeUnit**: `TimeUnit.Seconds` -- **Scope**: [Server-wide](../../server/configuration/configuration-options.mdx#settings.json) +- **Scope**: [Server-wide](../../server/configuration/configuration-options.mdx#settingsjson) or [per database](../../studio/database/settings/database-settings.mdx#view-database-settings) diff --git a/versioned_docs/version-7.0/server/configuration/security-configuration.mdx b/versioned_docs/version-7.0/server/configuration/security-configuration.mdx index faf576ef01..cd3a397b43 100644 --- a/versioned_docs/version-7.0/server/configuration/security-configuration.mdx +++ b/versioned_docs/version-7.0/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#security.auditlog.enablearchivefilecompression) - [Security.AuditLog.FolderPath](../../server/configuration/security-configuration.mdx#security.auditlog.folderpath) - [Security.AuditLog.ArchiveAboveSizeInMb](../../server/configuration/security-configuration.mdx#security.auditlog.archiveabovesizeinmb) - [Security.AuditLog.MaxArchiveDays](../../server/configuration/security-configuration.mdx#security.auditlog.maxarchivedays) + [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.Certificate: - [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#security.certificate.change.exec) - [Security.Certificate.Change.Exec.Arguments](../../server/configuration/security-configuration.mdx#security.certificate.change.exec.arguments) - [Security.Certificate.Exec](../../server/configuration/security-configuration.mdx#security.certificate.exec) - [Security.Certificate.Exec.TimeoutInSec](../../server/configuration/security-configuration.mdx#security.certificate.exec.timeoutinsec) - [Security.Certificate.ExpiringThresholdInDays](../../server/configuration/security-configuration.mdx#security.certificate.expiringthresholdindays) - [Security.Certificate.LetsEncrypt.Email](../../server/configuration/security-configuration.mdx#security.certificate.letsencrypt.email) - [Security.Certificate.Load.Exec](../../server/configuration/security-configuration.mdx#security.certificate.load.exec) - [Security.Certificate.Load.Exec.Arguments](../../server/configuration/security-configuration.mdx#security.certificate.load.exec.arguments) - [Security.Certificate.Password](../../server/configuration/security-configuration.mdx#security.certificate.password) - [Security.Certificate.Path](../../server/configuration/security-configuration.mdx#security.certificate.path) - [Security.Certificate.Renew.Exec](../../server/configuration/security-configuration.mdx#security.certificate.renew.exec) - [Security.Certificate.Renew.Exec.Arguments](../../server/configuration/security-configuration.mdx#security.certificate.renew.exec.arguments) - [Security.Certificate.Validation.Exec](../../server/configuration/security-configuration.mdx#security.certificate.validation.exec) - [Security.Certificate.Validation.Exec.Arguments](../../server/configuration/security-configuration.mdx#security.certificate.validation.exec.arguments) - [Security.Certificate.Validation.Exec.TimeoutInSec](../../server/configuration/security-configuration.mdx#security.certificate.validation.exec.timeoutinsec) - [Security.Certificate.Validation.KeyUsages](../../server/configuration/security-configuration.mdx#security.certificate.validation.keyusages) + [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.Csrf: - [Security.Csrf.AdditionalOriginHeaders](../../server/configuration/security-configuration.mdx#security.csrf.additionaloriginheaders) - [Security.Csrf.Enabled](../../server/configuration/security-configuration.mdx#security.csrf.enabled) - [Security.Csrf.TrustedOrigins](../../server/configuration/security-configuration.mdx#security.csrf.trustedorigins) + [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.MasterKey: - [Security.MasterKey.Exec](../../server/configuration/security-configuration.mdx#security.masterkey.exec) - [Security.MasterKey.Exec.Arguments](../../server/configuration/security-configuration.mdx#security.masterkey.exec.arguments) - [Security.MasterKey.Exec.TimeoutInSec](../../server/configuration/security-configuration.mdx#security.masterkey.exec.timeoutinsec) - [Security.MasterKey.Path](../../server/configuration/security-configuration.mdx#security.masterkey.path) + [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.TwoFactor: - [Security.TwoFactor.DefaultSessionDurationInMin](../../server/configuration/security-configuration.mdx#security.twofactor.defaultsessiondurationinmin) - [Security.TwoFactor.MaxSessionDurationInMin](../../server/configuration/security-configuration.mdx#security.twofactor.maxsessiondurationinmin) + [Security.TwoFactor.DefaultSessionDurationInMin](../../server/configuration/security-configuration.mdx#securitytwofactordefaultsessiondurationinmin) + [Security.TwoFactor.MaxSessionDurationInMin](../../server/configuration/security-configuration.mdx#securitytwofactormaxsessiondurationinmin) * Certificate and issuer validation: - [Security.WellKnownCertificates.Admin](../../server/configuration/security-configuration.mdx#security.wellknowncertificates.admin) - [Security.WellKnownIssuerHashes.Admin](../../server/configuration/security-configuration.mdx#security.wellknownissuerhashes.admin) - [Security.WellKnownIssuers.Admin](../../server/configuration/security-configuration.mdx#security.wellknownissuers.admin) - [Security.WellKnownIssuers.Admin.ValidateCertificateNames](../../server/configuration/security-configuration.mdx#security.wellknownissuers.admin.validatecertificatenames) + [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) * Other: - [Security.DisableHsts](../../server/configuration/security-configuration.mdx#security.disablehsts) - [Security.DisableHttpsRedirection](../../server/configuration/security-configuration.mdx#security.disablehttpsredirection) - [Security.DoNotConsiderMemoryLockFailureAsCatastrophicError](../../server/configuration/security-configuration.mdx#security.donotconsidermemorylockfailureascatastrophicerror) - [Security.TlsCipherSuites](../../server/configuration/security-configuration.mdx#security.tlsciphersuites) - [Security.UnsecuredAccessAllowed](../../server/configuration/security-configuration.mdx#security.unsecuredaccessallowed) + [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.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#security.certificate.path) is not defined. +Note: it will only be triggered if [Security.Certificate.Path](../../server/configuration/security-configuration.mdx#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#security.certificate.change.exec) command or executable. +The command line arguments for the [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#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#security.certificate.load.exec) -along with [Security.Certificate.Renew.Exec](../../server/configuration/security-configuration.mdx#security.certificate.renew.exec) -and [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#security.certificate.change.exec) instead. +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. @@ -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#security.certificate.load.exec) - * [Security.Certificate.Renew.Exec](../../server/configuration/security-configuration.mdx#security.certificate.renew.exec) - * [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#security.certificate.change.exec) + * [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) - **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#security.certificate.path) setting takes precedence over this executable. +* The [Security.Certificate.Path](../../server/configuration/security-configuration.mdx#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#security.certificate.load.exec) command or executable. +The command line arguments for the [Security.Certificate.Load.Exec](../../server/configuration/security-configuration.mdx#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#security.certificate.change.exec) +* The executable specified in [Security.Certificate.Change.Exec](../../server/configuration/security-configuration.mdx#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#security.certificate.renew.exec.arguments) command or executable. +The command line arguments for the [Security.Certificate.Renew.Exec](../../server/configuration/security-configuration.mdx#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#security.certificate.validation.exec.arguments) command or executable. +The optional user arguments for the [Security.Certificate.Validation.Exec](../../server/configuration/security-configuration.mdx#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#security.certificate.validation.exec.arguments) executable to exit. +The number of seconds to wait for the [Security.Certificate.Validation.Exec](../../server/configuration/security-configuration.mdx#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#security.masterkey.exec) command or executable. +The command line arguments for the [Security.MasterKey.Exec](../../server/configuration/security-configuration.mdx#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#security.wellknownissuers.admin) instead. +Use [Security.WellKnownIssuers.Admin](../../server/configuration/security-configuration.mdx#securitywellknownissuersadmin) instead. diff --git a/versioned_docs/version-7.0/server/configuration/server-configuration.mdx b/versioned_docs/version-7.0/server/configuration/server-configuration.mdx index 05f8f5d5af..ddfa8732c1 100644 --- a/versioned_docs/version-7.0/server/configuration/server-configuration.mdx +++ b/versioned_docs/version-7.0/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#server.maxtimefortasktowaitfordatabasetoloadinsec) - * [Server.ProcessAffinityMask](../../server/configuration/server-configuration.mdx#server.processaffinitymask) - * [Server.IndexingAffinityMask](../../server/configuration/server-configuration.mdx#server.indexingaffinitymask) - * [Server.NumberOfUnusedCoresByIndexes](../../server/configuration/server-configuration.mdx#server.numberofunusedcoresbyindexes) - * [Server.CpuCredits.ExhaustionBackupDelayInMin](../../server/configuration/server-configuration.mdx#server.cpucredits.exhaustionbackupdelayinmin) - * [Server.Tcp.Compression.Disable](../../server/configuration/server-configuration.mdx#server.tcp.compression.disable) + * [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 diff --git a/versioned_docs/version-7.0/server/configuration/storage-configuration.mdx b/versioned_docs/version-7.0/server/configuration/storage-configuration.mdx index 556fa7a7f7..6f5830c572 100644 --- a/versioned_docs/version-7.0/server/configuration/storage-configuration.mdx +++ b/versioned_docs/version-7.0/server/configuration/storage-configuration.mdx @@ -31,7 +31,7 @@ The following configuration options allow you configure [the storage engine](../ * The Databases temporary files will be written to `"/Databases/{database-name}"`. * The Configuration temporary files will be written to `"/Databases/{database-name}/Configuration"`. -* To specify a different path for the indexes temporary files go to [Indexing.TempPath](../../server/configuration/indexing-configuration.mdx#indexing.temppath). +* To specify a different path for the indexes temporary files go to [Indexing.TempPath](../../server/configuration/indexing-configuration.mdx#indexingtemppath). * Learn more about RavenDB directory structure [here](../../server/storage/directory-structure.mdx). - **Type**: `string` diff --git a/versioned_docs/version-7.0/server/configuration/subscription-configuration.mdx b/versioned_docs/version-7.0/server/configuration/subscription-configuration.mdx index 090f050f0b..7d1e19e83c 100644 --- a/versioned_docs/version-7.0/server/configuration/subscription-configuration.mdx +++ b/versioned_docs/version-7.0/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#subscriptions.archiveddataprocessingbehavior) - * [Subscriptions.MaxNumberOfConcurrentConnections](../../server/configuration/subscription-configuration.mdx#subscriptions.maxnumberofconcurrentconnections) + * [Subscriptions.ArchivedDataProcessingBehavior](../../server/configuration/subscription-configuration.mdx#subscriptionsarchiveddataprocessingbehavior) + * [Subscriptions.MaxNumberOfConcurrentConnections](../../server/configuration/subscription-configuration.mdx#subscriptionsmaxnumberofconcurrentconnections) diff --git a/versioned_docs/version-7.0/server/embedded.mdx b/versioned_docs/version-7.0/server/embedded.mdx index a6a47b2be2..902004d2f5 100644 --- a/versioned_docs/version-7.0/server/embedded.mdx +++ b/versioned_docs/version-7.0/server/embedded.mdx @@ -34,7 +34,7 @@ export const supportedLanguages = ["csharp", "java"]; * [Restarting the Server](../server/embedded.mdx#restarting-the-server) * [ServerProcessExited Event](../server/embedded.mdx#serverprocessexited-event) * [Licensing options](../server/embedded.mdx#licensing-options) - * [.NET FrameworkVersion](../server/embedded.mdx#.net-frameworkversion) + * [.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) diff --git a/versioned_docs/version-7.0/server/kb/javascript-engine.mdx b/versioned_docs/version-7.0/server/kb/javascript-engine.mdx index a7e0c4cd61..68c302b759 100644 --- a/versioned_docs/version-7.0/server/kb/javascript-engine.mdx +++ b/versioned_docs/version-7.0/server/kb/javascript-engine.mdx @@ -47,9 +47,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * **Execution limitations**: * RavenDB limits the amount of statements that can be performed for each document processing. - The default value is **10,000** and it can be set using the [Patching.MaxStepsForScript](../../server/configuration/patching-configuration.mdx#patching.maxstepsforscript) configuration. + The default value is **10,000** and it can be set using the [Patching.MaxStepsForScript](../../server/configuration/patching-configuration.mdx#patchingmaxstepsforscript) configuration. * RavenDB limits the amount of cached Jint engines. - The default value is **2,048** and it can be set using the [Patching.MaxNumberOfCachedScripts](../../server/configuration/patching-configuration.mdx#patching.maxstepsforscript) configuration. + The default value is **2,048** and it can be set using the [Patching.MaxNumberOfCachedScripts](../../server/configuration/patching-configuration.mdx#patchingmaxstepsforscript) configuration. * Recursive calls within scripts are limited to a depth of **64**, a constant value that cannot be modified. diff --git a/versioned_docs/version-7.0/server/ongoing-tasks/etl/basics.mdx b/versioned_docs/version-7.0/server/ongoing-tasks/etl/basics.mdx index 38c5bd9a99..6ddb0f6c51 100644 --- a/versioned_docs/version-7.0/server/ongoing-tasks/etl/basics.mdx +++ b/versioned_docs/version-7.0/server/ongoing-tasks/etl/basics.mdx @@ -198,16 +198,16 @@ For each ETL type, the target must be: Documents are extracted and transformed by the ETL process in a batch manner. The number of documents processed depends on the following configuration limits: -* [`ETL.ExtractAndTransformTimeoutInSec`](../../../server/configuration/etl-configuration.mdx#etl.extractandtransformtimeoutinsec) (default: 30 sec) +* [`ETL.ExtractAndTransformTimeoutInSec`](../../../server/configuration/etl-configuration.mdx#etlextractandtransformtimeoutinsec) (default: 30 sec) Time-frame for the extraction and transformation stages (in seconds), after which the loading stage will start. -* [`ETL.MaxNumberOfExtractedDocuments`](../../../server/configuration/etl-configuration.mdx#etl.maxnumberofextracteddocuments) (default: 8192) +* [`ETL.MaxNumberOfExtractedDocuments`](../../../server/configuration/etl-configuration.mdx#etlmaxnumberofextracteddocuments) (default: 8192) Maximum number of extracted documents in an ETL batch. -* [`ETL.MaxNumberOfExtractedItems`](../../../server/configuration/etl-configuration.mdx#etl.maxnumberofextracteditems) (default: 8192) +* [`ETL.MaxNumberOfExtractedItems`](../../../server/configuration/etl-configuration.mdx#etlmaxnumberofextracteditems) (default: 8192) Maximum number of extracted items (documents, counters) in an ETL batch. -* [`ETL.MaxBatchSizeInMb`](../../../server/configuration/etl-configuration.mdx#etl.maxbatchsizeinmb) (default: 64 MB) +* [`ETL.MaxBatchSizeInMb`](../../../server/configuration/etl-configuration.mdx#etlmaxbatchsizeinmb) (default: 64 MB) Maximum size of an ETL batch in MB. @@ -259,7 +259,7 @@ You will be notified if any of the following events happen: If the ETL cannot proceed the load stage (e.g. it can't connect to the destination) then it enters the fallback mode. The fallback mode means suspending the process and retrying it periodically. The fallback time starts from 5 seconds and it's doubled on every consecutive error according to the time passed since the last error, -but it never crosses [`ETL.MaxFallbackTimeInSec`](../../../server/configuration/etl-configuration.mdx#etl.maxfallbacktimeinsec) configuration (default: 900 sec). +but it never crosses [`ETL.MaxFallbackTimeInSec`](../../../server/configuration/etl-configuration.mdx#etlmaxfallbacktimeinsec) configuration (default: 900 sec). Once the process is in the fallback mode, then the _Reconnect_ state is shown in the Studio. diff --git a/versioned_docs/version-7.0/server/ongoing-tasks/etl/olap.mdx b/versioned_docs/version-7.0/server/ongoing-tasks/etl/olap.mdx index 0902fb1757..33d0b31b61 100644 --- a/versioned_docs/version-7.0/server/ongoing-tasks/etl/olap.mdx +++ b/versioned_docs/version-7.0/server/ongoing-tasks/etl/olap.mdx @@ -109,7 +109,7 @@ This is the list of different settings objects that the `OlapConnectionString` o | Property | Type | Description | | - | - | - | -| `FolderPath` | `string` | Path to local folder. If this property is not set, the data is saved to the location specified in [the setting `Storage.TempPath`](../../../server/configuration/storage-configuration.mdx#storage.temppath). If _that_ setting has no value, the data is instead saved to the location specified in [the setting `CoreConfiguration.DataDirectory`](../../../server/configuration/core-configuration.mdx#datadir). | +| `FolderPath` | `string` | Path to local folder. If this property is not set, the data is saved to the location specified in [the setting `Storage.TempPath`](../../../server/configuration/storage-configuration.mdx#storagetemppath). If _that_ setting has no value, the data is instead saved to the location specified in [the setting `CoreConfiguration.DataDirectory`](../../../server/configuration/core-configuration.mdx#datadir). | #### `FtpSettings` diff --git a/versioned_docs/version-7.0/server/ongoing-tasks/etl/queue-etl/azure-queue.mdx b/versioned_docs/version-7.0/server/ongoing-tasks/etl/queue-etl/azure-queue.mdx index fdae2cfb71..5eb953e060 100644 --- a/versioned_docs/version-7.0/server/ongoing-tasks/etl/queue-etl/azure-queue.mdx +++ b/versioned_docs/version-7.0/server/ongoing-tasks/etl/queue-etl/azure-queue.mdx @@ -30,7 +30,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * [Azure Functions](https://learn.microsoft.com/en-us/azure/azure-functions/functions-overview?pivots=programming-language-csharp) can be triggered to consume and process messages that are sent to Azure queues, enabling powerful and flexible workflows. - The message visibility period and life span in the Queue can be customized through these [ETL configuration options](../../../../server/configuration/etl-configuration.mdx#etl.queue.azurequeuestorage.timetoliveinsec). + The message visibility period and life span in the Queue can be customized through these [ETL configuration options](../../../../server/configuration/etl-configuration.mdx#etlqueueazurequeuestoragetimetoliveinsec). * Read more about Azure Queue Storage in the platform's [official documentation](https://learn.microsoft.com/en-us/azure/storage/queues/storage-queues-introduction). * This article focuses on how to create an Azure Queue Storage ETL task using the Client API. diff --git a/versioned_docs/version-7.0/server/ongoing-tasks/etl/sql.mdx b/versioned_docs/version-7.0/server/ongoing-tasks/etl/sql.mdx index 7c20ea955a..12991c890e 100644 --- a/versioned_docs/version-7.0/server/ongoing-tasks/etl/sql.mdx +++ b/versioned_docs/version-7.0/server/ongoing-tasks/etl/sql.mdx @@ -311,7 +311,7 @@ The SQL ETL task does not support sending [Counters](../../../document-extension * **Command timeout** Number of seconds after which SQL command will timeout. - It overrides the value defined in the [ETL.SQL.CommandTimeoutInSec](../../../server/configuration/etl-configuration.mdx#etl.sql.commandtimeoutinsec) configuration key. + It overrides the value defined in the [ETL.SQL.CommandTimeoutInSec](../../../server/configuration/etl-configuration.mdx#etlsqlcommandtimeoutinsec) configuration key. Default: `null` (use provider default). * **Parameterized deletes** Control whether DELETE statements generated during the ETL process use parameterized SQL queries, diff --git a/versioned_docs/version-7.0/server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx b/versioned_docs/version-7.0/server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx index fe42113ee4..9262645a22 100644 --- a/versioned_docs/version-7.0/server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx +++ b/versioned_docs/version-7.0/server/ongoing-tasks/queue-sink/kafka-queue-sink.mdx @@ -303,9 +303,9 @@ AddQueueSinkOperationResult addQueueSinkOperationResult = Use these configuration options to gain more control over queue sink tasks. -* [QueueSink.MaxBatchSize](../../../server/configuration/queue-sink-configuration.mdx#queuesink.maxbatchsize) +* [QueueSink.MaxBatchSize](../../../server/configuration/queue-sink-configuration.mdx#queuesinkmaxbatchsize) The maximum number of pulled messages consumed in a single batch. -* [QueueSink.MaxFallbackTimeInSec](../../../server/configuration/queue-sink-configuration.mdx#queuesink.maxfallbacktimeinsec) +* [QueueSink.MaxFallbackTimeInSec](../../../server/configuration/queue-sink-configuration.mdx#queuesinkmaxfallbacktimeinsec) The maximum number of seconds the Queue Sink process will be in a fallback mode (i.e. suspending the process) after a connection failure. diff --git a/versioned_docs/version-7.0/server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx b/versioned_docs/version-7.0/server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx index 6e12efa79e..b4e2fb6a6a 100644 --- a/versioned_docs/version-7.0/server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx +++ b/versioned_docs/version-7.0/server/ongoing-tasks/queue-sink/rabbit-mq-queue-sink.mdx @@ -290,9 +290,9 @@ AddQueueSinkOperationResult addQueueSinkOperationResult = Use these configuration options to gain more control over queue sink tasks. -* [QueueSink.MaxBatchSize](../../../server/configuration/queue-sink-configuration.mdx#queuesink.maxbatchsize) +* [QueueSink.MaxBatchSize](../../../server/configuration/queue-sink-configuration.mdx#queuesinkmaxbatchsize) The maximum number of pulled messages consumed in a single batch. -* [QueueSink.MaxFallbackTimeInSec](../../../server/configuration/queue-sink-configuration.mdx#queuesink.maxfallbacktimeinsec) +* [QueueSink.MaxFallbackTimeInSec](../../../server/configuration/queue-sink-configuration.mdx#queuesinkmaxfallbacktimeinsec) The maximum number of seconds the Queue Sink process will be in a fallback mode (i.e. suspending the process) after a connection failure. diff --git a/versioned_docs/version-7.0/server/security/audit-log/audit-log-overview.mdx b/versioned_docs/version-7.0/server/security/audit-log/audit-log-overview.mdx index a607b0463e..996c0308f3 100644 --- a/versioned_docs/version-7.0/server/security/audit-log/audit-log-overview.mdx +++ b/versioned_docs/version-7.0/server/security/audit-log/audit-log-overview.mdx @@ -32,15 +32,15 @@ import LanguageContent from "@site/src/components/LanguageContent"; ## Enabling the audit log * **To enable writing to the audit log**, set the following configuration key: - * [Security.AuditLog.FolderPath](../../../server/configuration/security-configuration.mdx#security.auditlog.folderpath) - set the path to a folder where RavenDB will store the audit logs. + * [Security.AuditLog.FolderPath](../../../server/configuration/security-configuration.mdx#securityauditlogfolderpath) - set the path to a folder where RavenDB will store the audit logs. * In addition, the following configurations are available: - * [Security.AuditLog.ArchiveAboveSizeInMb](../../../server/configuration/security-configuration.mdx#security.auditlog.archiveabovesizeinmb) + * [Security.AuditLog.ArchiveAboveSizeInMb](../../../server/configuration/security-configuration.mdx#securityauditlogarchiveabovesizeinmb) The maximum size an audit log file may reach before it is archived and logging is directed to a new file. - * [Security.AuditLog.EnableArchiveFileCompression](../../../server/configuration/security-configuration.mdx#security.auditlog.enablearchivefilecompression) - determine whether to compress the audit log files. - * [Security.AuditLog.MaxArchiveDays](../../../server/configuration/security-configuration.mdx#security.auditlog.maxarchivedays) - the maximum number of days that an archived audit log file is kept. - * [Security.AuditLog.MaxArchiveFiles](../../../server/configuration/security-configuration.mdx#security.auditlog.maxarchivefiles) - the maximum number of archived audit log files to keep. - * [Logs.ArchiveAboveSizeInMb](../../../server/configuration/logs-configuration.mdx#logs.archiveabovesizeinmb) - a new log file is created when this limit is reached (or daily). + * [Security.AuditLog.EnableArchiveFileCompression](../../../server/configuration/security-configuration.mdx#securityauditlogenablearchivefilecompression) - determine whether to compress the audit log files. + * [Security.AuditLog.MaxArchiveDays](../../../server/configuration/security-configuration.mdx#securityauditlogmaxarchivedays) - the maximum number of days that an archived audit log file is kept. + * [Security.AuditLog.MaxArchiveFiles](../../../server/configuration/security-configuration.mdx#securityauditlogmaxarchivefiles) - the maximum number of archived audit log files to keep. + * [Logs.ArchiveAboveSizeInMb](../../../server/configuration/logs-configuration.mdx#logsarchiveabovesizeinmb) - a new log file is created when this limit is reached (or daily). * Learn how to set configuration keys in this [configuration overview](../../../server/configuration/configuration-options.mdx). diff --git a/versioned_docs/version-7.0/server/security/authentication/certificate-configuration.mdx b/versioned_docs/version-7.0/server/security/authentication/certificate-configuration.mdx index fbac3d6b4d..6b1ac65ded 100644 --- a/versioned_docs/version-7.0/server/security/authentication/certificate-configuration.mdx +++ b/versioned_docs/version-7.0/server/security/authentication/certificate-configuration.mdx @@ -38,7 +38,7 @@ authentication in a much easier and faster way with automatic certificate renewa ## Prerequisites To enable authentication, either `Security.Certificate.Path` or `Security.Certificate.Load.Exec` must be set in [settings.json](../../configuration/configuration-options.mdx#json). - Please note that `Security.Certificate.Load.Exec` has replaced the old `Security.Certificate.Exec` as of 4.2 - [see FAQ](../../../server/security/common-errors-and-faq.mdx#automatic-cluster-certificate-renewal-following-migration-to-4.2). + Please note that `Security.Certificate.Load.Exec` has replaced the old `Security.Certificate.Exec` as of 4.2 - [see FAQ](../../../server/security/common-errors-and-faq.mdx#automatic-cluster-certificate-renewal-following-migration-to-42). #### 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). @@ -81,7 +81,7 @@ and include a basic (`Key Usage`) field and an enhanced (`Enhanced Key Usage`) f #### Certificate Location -A [settings.json](../../configuration/configuration-options.mdx#settings.json) file must reside in each node's `Server` folder +A [settings.json](../../configuration/configuration-options.mdx#settingsjson) file must reside in each node's `Server` folder and define the server and certificate settings. The server will retrieve this file and use its settings on startup. Read more about RavenDB configuration options [here](../../configuration/configuration-options.mdx). diff --git a/versioned_docs/version-7.0/server/security/authorization/security-clearance-and-permissions.mdx b/versioned_docs/version-7.0/server/security/authorization/security-clearance-and-permissions.mdx index b0bec6ec14..1e12df432e 100644 --- a/versioned_docs/version-7.0/server/security/authorization/security-clearance-and-permissions.mdx +++ b/versioned_docs/version-7.0/server/security/authorization/security-clearance-and-permissions.mdx @@ -112,7 +112,7 @@ A `User` certificate with a `Read/Write` access level can perform all operations * [JavaScript static indexes](../../../indexes/javascript-indexes.mdx) are permitted by default with Read/Write User certificates. To configure a server or database so that only Admin certificates will be able to deploy JavaScript static indexes, - set [Indexing.Static.RequireAdminToDeployJavaScriptIndexes](../../../server/configuration/indexing-configuration.mdx#indexing.static.requireadmintodeployjavascriptindexes) + set [Indexing.Static.RequireAdminToDeployJavaScriptIndexes](../../../server/configuration/indexing-configuration.mdx#indexingstaticrequireadmintodeployjavascriptindexes) to `true`. ### `Read Only` diff --git a/versioned_docs/version-7.0/server/security/common-errors-and-faq.mdx b/versioned_docs/version-7.0/server/security/common-errors-and-faq.mdx index e5ad83daf7..b8159f27b5 100644 --- a/versioned_docs/version-7.0/server/security/common-errors-and-faq.mdx +++ b/versioned_docs/version-7.0/server/security/common-errors-and-faq.mdx @@ -233,7 +233,7 @@ Learn how to handle this issue [here](../../server/security/authentication/solve * [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-4.2) +* [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 You cannot access Studio using Edge, though during @@ -453,7 +453,7 @@ In PowerShell it can be solved like this: An admin client certificate can be generated through the [RavenDB CLI](../../server/administration/cli#generateclientcert If RavenDB runs as a console application, the CLI is just there. When running as a service, please use the `rvn admin-channel`. Use either the [generateClientCert](../../server/administration/cli.mdx#generateclientcert) command, or (if you already have a certificate) the [trustClientCert](../../server/administration/cli.mdx#trustclientcert) command. -Another way to gain access for an existing certificate is to add the [Security.WellKnownCertificates.Admin](../../server/configuration/security-configuration.mdx#security.wellknowncertificates.admin) configuration to `settings.json` with your existing certificate's thumbprint. +Another way to gain access for an existing certificate is to add the [Security.WellKnownCertificates.Admin](../../server/configuration/security-configuration.mdx#securitywellknowncertificatesadmin) configuration to `settings.json` with your existing certificate's thumbprint. In this case, a server restart is required. ### Certificate is not recognized when setting up on Azure App Services @@ -502,7 +502,7 @@ Treating this as a catastrophic error and aborting the current operation. When encryption is turned on, RavenDB locks memory in order to avoid leaking secrets to disk. Read more [here](../../server/security/encryption/encryption-at-rest.mdx#locking-memory). By default, RavenDB treats this error as catastrophic and will not continue the operation. -You can change this behavior but it's not recommended and should be done only after a proper security analysis is performed, see the [Security Configuration Section](../../server/configuration/security-configuration.mdx#security.donotconsidermemorylockfailureascatastrophicerror). +You can change this behavior but it's not recommended and should be done only after a proper security analysis is performed, see the [Security Configuration Section](../../server/configuration/security-configuration.mdx#securitydonotconsidermemorylockfailureascatastrophicerror). If such a catastrophic error occurs in **Windows**, RavenDB will try to recover automatically by increasing the size of the minimum working set and retrying the operation. In **Linux**, it is the admin's responsibility to configure higher limits manually using: diff --git a/versioned_docs/version-7.0/server/security/encryption/database-encryption.mdx b/versioned_docs/version-7.0/server/security/encryption/database-encryption.mdx index 2c990ee7d0..d2a8e4789c 100644 --- a/versioned_docs/version-7.0/server/security/encryption/database-encryption.mdx +++ b/versioned_docs/version-7.0/server/security/encryption/database-encryption.mdx @@ -150,7 +150,7 @@ Database encryption must be enabled when creating the database. If you wish to u Indexing is most efficient when it is performed in the largest transactions possible. However, using encryption is very memory intensive, and if memory runs out before the transaction completes, the entire transaction will fail. To avoid this, you can limit the size of indexing batches in encrypted -databases using [Indexing.Encrypted.TransactionSizeLimitInMb](../../../server/configuration/indexing-configuration.mdx#indexing.encrypted.transactionsizelimitinmb). +databases using [Indexing.Encrypted.TransactionSizeLimitInMb](../../../server/configuration/indexing-configuration.mdx#indexingencryptedtransactionsizelimitinmb). diff --git a/versioned_docs/version-7.0/server/security/encryption/encryption-at-rest.mdx b/versioned_docs/version-7.0/server/security/encryption/encryption-at-rest.mdx index 45a4a1dedf..5d2a6d34ac 100644 --- a/versioned_docs/version-7.0/server/security/encryption/encryption-at-rest.mdx +++ b/versioned_docs/version-7.0/server/security/encryption/encryption-at-rest.mdx @@ -45,7 +45,7 @@ request, and when the transaction is finished, modified pages are encrypted and Indexing is most efficient when it is performed in the largest transactions possible. However, using encryption can be very memory intensive, and if memory runs out before the transaction completes, the entire transaction will fail. To avoid this, you can limit the size of indexing batches in encrypted -databases using [Indexing.Encrypted.TransactionSizeLimitInMb](../../../server/configuration/indexing-configuration.mdx#indexing.encrypted.transactionsizelimitinmb). +databases using [Indexing.Encrypted.TransactionSizeLimitInMb](../../../server/configuration/indexing-configuration.mdx#indexingencryptedtransactionsizelimitinmb). The default limit is 64 MB. @@ -64,7 +64,7 @@ However, the memory-mapped files used for **special temporary buffers** (compres We lock the memory regions used by these buffers in order to avoid leaking secrets to disk. This means that if we run out of memory, the OS is not allowed to page these buffers to disk. The downside to this approach is that if we run out of physical RAM RavenDB won't be able to lock memory and will abort the current operation. -You can change this behavior but it's not recommended and should be done only after a proper security analysis is performed, see the [Security Configuration Section](../../../server/configuration/security-configuration.mdx#security.donotconsidermemorylockfailureascatastrophicerror). +You can change this behavior but it's not recommended and should be done only after a proper security analysis is performed, see the [Security Configuration Section](../../../server/configuration/security-configuration.mdx#securitydonotconsidermemorylockfailureascatastrophicerror). If such a catastrophic error occurs in **Windows**, RavenDB will try to recover automatically by increasing the size of the minimum working set and retrying the operation. RavenDB's ability to do this may be limited by the ['increase a process working set' policy setting](https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/increase-a-process-working-set), diff --git a/versioned_docs/version-7.0/server/storage/customizing-raven-data-files-locations.mdx b/versioned_docs/version-7.0/server/storage/customizing-raven-data-files-locations.mdx index c2cfb45491..8ae84c0444 100644 --- a/versioned_docs/version-7.0/server/storage/customizing-raven-data-files-locations.mdx +++ b/versioned_docs/version-7.0/server/storage/customizing-raven-data-files-locations.mdx @@ -46,26 +46,26 @@ import LanguageContent from "@site/src/components/LanguageContent"; * __System temporary files__ By default, temporary files containing cluster data and server-wide data are written to the `Temp` folder under the System directory. - Customize the path for these files by setting the [Storage.TempPath](../../server/configuration/storage-configuration.mdx#storage.temppath) configuration option. + Customize the path for these files by setting the [Storage.TempPath](../../server/configuration/storage-configuration.mdx#storagetemppath) configuration option. The temporary files will be written to the combined path `"/System"`. * __Databases temporary files__ By default, all databases' temporary files are written to the `Temp` folder under each Database directory. - Customize the path for these files by setting the [Storage.TempPath](../../server/configuration/storage-configuration.mdx#storage.temppath) configuration option. + Customize the path for these files by setting the [Storage.TempPath](../../server/configuration/storage-configuration.mdx#storagetemppath) configuration option. The temporary files will be written to `"/Databases/{database-name}"`. * __Configuration temporary files__ By default, the configuration temporary files are written to the `Temp` folder under the Configuration directory per database. - Customize the path for these files by setting the [Storage.TempPath](../../server/configuration/storage-configuration.mdx#storage.temppath) configuration option. + Customize the path for these files by setting the [Storage.TempPath](../../server/configuration/storage-configuration.mdx#storagetemppath) configuration option. The temporary files will be written to `"/Databases/{database-name}/Configuration"`. * __Indexes temporary files__ By default, all indexes' temporary files are written to the `Temp` folder under each Index directory. - Customize the path for these files by setting the [Indexing.TempPath](../../server/configuration/indexing-configuration.mdx#indexing.temppath) configuration option. + Customize the path for these files by setting the [Indexing.TempPath](../../server/configuration/indexing-configuration.mdx#indexingtemppath) configuration option. * __Backup temporary files__ By default, backup temporary files are written under the `Database` directory or under `Storage.TempPath` if defined. - Customize the path for these files by setting the [Backup.TempPath](../../server/configuration/backup-configuration.mdx#backup.temppath) configuration option. + Customize the path for these files by setting the [Backup.TempPath](../../server/configuration/backup-configuration.mdx#backuptemppath) configuration option. @@ -137,7 +137,7 @@ ln -s /mnt/FastDrive/Databases/Northwind/Indexes ~/RavenDB/Server/RavenData/Data ## Automate storage definitions -* To help automate the process, we have added the [on directory initialize](../../server/configuration/storage-configuration.mdx#storage.ondirectoryinitialize.exec) configuration option. +* To help automate the process, we have added the [on directory initialize](../../server/configuration/storage-configuration.mdx#storageondirectoryinitializeexec) configuration option. Whenever RavenDB __creates a directory__, it will invoke the process that is defined within that configuration. * The process is called just before the directory is created. @@ -145,7 +145,7 @@ ln -s /mnt/FastDrive/Databases/Northwind/Indexes ~/RavenDB/Server/RavenData/Data * RavenDB will invoke the process with the following params: * Params passed by the user: - * User arguments - optional params, set in the [optional user arguments](../../server/configuration/storage-configuration.mdx#storage.ondirectoryinitialize.exec.arguments) configuration option + * User arguments - optional params, set in the [optional user arguments](../../server/configuration/storage-configuration.mdx#storageondirectoryinitializeexecarguments) configuration option * Params passed by RavenDB: * The environment type (System, Database, Index, Configuration, Compaction) diff --git a/versioned_docs/version-7.0/server/storage/documents-compression.mdx b/versioned_docs/version-7.0/server/storage/documents-compression.mdx index 30f1bb2b03..410bb0cb14 100644 --- a/versioned_docs/version-7.0/server/storage/documents-compression.mdx +++ b/versioned_docs/version-7.0/server/storage/documents-compression.mdx @@ -25,7 +25,7 @@ export const supportedLanguages = ["csharp", "nodejs"]; to achieve more efficient data storage with constantly improving compression ratios. * Documents compression can be set for all collections, selected collections, and revisions. - Default compression settings are [configurable](../../server/configuration/database-configuration.mdx#databases.compression.compressallcollectionsdefault). + Default compression settings are [configurable](../../server/configuration/database-configuration.mdx#databasescompressioncompressallcollectionsdefault). * When turned on, compression will be applied to: * **New documents**: @@ -194,7 +194,7 @@ await store.Maintenance.Server.SendAsync(new UpdateDatabaseOperation(dbrecord, d to achieve more efficient data storage with constantly improving compression ratios. * Documents compression can be set for all collections, selected collections, and revisions. - Default compression settings are [configurable](../../server/configuration/database-configuration.mdx#databases.compression.compressallcollectionsdefault). + Default compression settings are [configurable](../../server/configuration/database-configuration.mdx#databasescompressioncompressallcollectionsdefault). * When turned on, compression will be applied to: * **New documents**: diff --git a/versioned_docs/version-7.0/server/tcp-compression.mdx b/versioned_docs/version-7.0/server/tcp-compression.mdx index 0876ca922b..06e7493040 100644 --- a/versioned_docs/version-7.0/server/tcp-compression.mdx +++ b/versioned_docs/version-7.0/server/tcp-compression.mdx @@ -88,7 +88,7 @@ No additional configuration is needed to enable this feature. * TCP Compression can also be disabled server-wide, using the - server [Server.Tcp.Compression.Disable](../server/configuration/server-configuration.mdx#server.tcp.compression.disable) configuration. + server [Server.Tcp.Compression.Disable](../server/configuration/server-configuration.mdx#servertcpcompressiondisable) configuration. Learn how to change database settings using Studio [here](../studio/database/settings/database-settings.mdx). diff --git a/versioned_docs/version-7.0/server/troubleshooting/collect-info.mdx b/versioned_docs/version-7.0/server/troubleshooting/collect-info.mdx index 0d63735b6c..933b905953 100644 --- a/versioned_docs/version-7.0/server/troubleshooting/collect-info.mdx +++ b/versioned_docs/version-7.0/server/troubleshooting/collect-info.mdx @@ -124,9 +124,9 @@ To preserve your settings after a restart, you can either: ![Save to settings.json](./assets/save-to-settings-json.png) * Or set the relevant configuration key, as described in this [configuration overview](../../server/configuration/configuration-options.mdx): - * For **Server logs**: set the [Logs.MinLevel](../../server/configuration/logs-configuration.mdx#logs.minlevel) configuration key. - * For **Microsoft logs**: set the [Logs.Microsoft.MinLevel](../../server/configuration/logs-configuration.mdx#logs.microsoft.minlevel) configuration key. - * For **Traffic watch logs**: set the [TrafficWatch.Mode](../../server/configuration/traffic-watch-configuration.mdx#trafficwatch.mode) configuration key. + * For **Server logs**: set the [Logs.MinLevel](../../server/configuration/logs-configuration.mdx#logsminlevel) configuration key. + * For **Microsoft logs**: set the [Logs.Microsoft.MinLevel](../../server/configuration/logs-configuration.mdx#logsmicrosoftminlevel) configuration key. + * For **Traffic watch logs**: set the [TrafficWatch.Mode](../../server/configuration/traffic-watch-configuration.mdx#trafficwatchmode) configuration key. @@ -159,11 +159,11 @@ __If the Studio is unavailable__, or if the logs downloaded via the Studio appea then copy the log files directly from the disk to another location to ensure that you keep them, avoiding potential loss due to the retention configuration. -* The location of the log files is determined by the [Logs.Path](../../server/configuration/logs-configuration.mdx#logs.path) configuration. +* The location of the log files is determined by the [Logs.Path](../../server/configuration/logs-configuration.mdx#logspath) configuration. * Logs deletion is controlled by the following configurations: - * [Logs.MaxArchiveDays](../../server/configuration/logs-configuration.mdx#logs.maxarchivedays) - * [Logs.MaxArchiveFiles ](../../server/configuration/logs-configuration.mdx#logs.maxarchivefiles) + * [Logs.MaxArchiveDays](../../server/configuration/logs-configuration.mdx#logsmaxarchivedays) + * [Logs.MaxArchiveFiles ](../../server/configuration/logs-configuration.mdx#logsmaxarchivefiles) diff --git a/versioned_docs/version-7.0/server/troubleshooting/logging.mdx b/versioned_docs/version-7.0/server/troubleshooting/logging.mdx index c2713a032a..1159d601b9 100644 --- a/versioned_docs/version-7.0/server/troubleshooting/logging.mdx +++ b/versioned_docs/version-7.0/server/troubleshooting/logging.mdx @@ -86,7 +86,7 @@ is integrated with. * [Using an external configuration file](../../server/troubleshooting/logging.mdx#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#logs.configpath) + 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 @@ -192,11 +192,11 @@ You **will** need to modify these settings, however, if you want to use NLog fea * **Default logging level** The default minimal logging level is `LogLevel.Info`. - To use a different level, set the - [Logs.MinLevel](../../server/configuration/logs-configuration.mdx#logs.minlevel) configuration key. + [Logs.MinLevel](../../server/configuration/logs-configuration.mdx#logsminlevel) configuration key. * **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#logs.path) configuration key. + [Logs.Path](../../server/configuration/logs-configuration.mdx#logspath) configuration key. - [Learn how to log to additional destinations](../../server/troubleshooting/logging.mdx#configuring-and-using-nlog) * **Default time standard** The default time standard used for log entries is `UTC`. @@ -225,7 +225,7 @@ Unlike the permanent customization methods described above (via internal configu keys or an external NLog file), that require a server restart to take effect, changes made using CLI commands will take **immediate effect**. However, they will also be overridden when the server is restarted and the permanent configuration is reloaded from -[settings.json](../../server/configuration/configuration-options.mdx#settings.json) +[settings.json](../../server/configuration/configuration-options.mdx#settingsjson) or the NLog configuration file. Use this syntax to customize logging via CLI: @@ -260,7 +260,7 @@ To use NLog you need to: NLog options are customized using an NLog configuration file. Direct RavenDB to the location of your configuration file using the -[Logs.ConfigPath](../../server/configuration/logs-configuration.mdx#logs.configpath) +[Logs.ConfigPath](../../server/configuration/logs-configuration.mdx#logsconfigpath) configuration key with the file's path as a value. #### Example: To use a configuration file named `NLog.config` that resides in the RavenDB server @@ -291,7 +291,7 @@ through which applications like RavenDB can stream log data to a variety of dest NLog plugins are available as Nuget packages, that we can easily instruct RavenDB to load and run during startup. We do this by defining the plugin Nuget package URL as a property of the -[Logs.NuGet.AdditionalPackages](../../server/configuration/logs-configuration.mdx#logs.nuget.additionalpackages) +[Logs.NuGet.AdditionalPackages](../../server/configuration/logs-configuration.mdx#logsnugetadditionalpackages) configuration key, with the plugin version we want to use as a value. #### Example To load a [Grafana Loki](https://grafana.com/oss/loki/) plugin, for example, @@ -310,11 +310,11 @@ property, with the plugin's version you want to use as a value. -* [Logs.NuGet.PackagesPath](../../server/configuration/logs-configuration.mdx#logs.nuget.packagespath) +* [Logs.NuGet.PackagesPath](../../server/configuration/logs-configuration.mdx#logsnugetpackagespath) Use this key to select the path to which NuGet packages are downloaded. -* [Logs.NuGet.PackageSourceUrl](../../server/configuration/logs-configuration.mdx#logs.nuget.packagesourceurl) +* [Logs.NuGet.PackageSourceUrl](../../server/configuration/logs-configuration.mdx#logsnugetpackagesourceurl) Use this key to set the default location from which NuGet packages are downloaded. -* [Logs.NuGet.AllowPreReleasePackages](../../server/configuration/logs-configuration.mdx#logs.nuget.allowprereleasepackages) +* [Logs.NuGet.AllowPreReleasePackages](../../server/configuration/logs-configuration.mdx#logsnugetallowprereleasepackages) Use this key to determine whether RavenDB is allowed to use pre-release versions of NuGet packages. diff --git a/versioned_docs/version-7.0/sharding/overview.mdx b/versioned_docs/version-7.0/sharding/overview.mdx index 9a4fcadea5..805c7ece7d 100644 --- a/versioned_docs/version-7.0/sharding/overview.mdx +++ b/versioned_docs/version-7.0/sharding/overview.mdx @@ -234,7 +234,7 @@ Using a node's local IP address for inter-cluster communications can speed up th Using this method can be particularly helpful in a sharded cluster, where each client request is handled by an orchestrator that may need to communicate with all other shards to process the request and its results. -Use [this configuration option](../server/configuration/core-configuration.mdx#serverurl.cluster) to expose a node's local IP address to other nodes. +Use [this configuration option](../server/configuration/core-configuration.mdx#serverurlcluster) to expose a node's local IP address to other nodes. 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 7e2f8e8a5b..6521d1a3ad 100644 --- a/versioned_docs/version-7.0/start/containers/requirements/security.mdx +++ b/versioned_docs/version-7.0/start/containers/requirements/security.mdx @@ -40,11 +40,11 @@ After getting your cert, start tuning the server to leverage it for security. RavenDB needs to get its server certificate. You can configure its retrieval from one of these origins: - Path - A .pfx certificate stored under a path reachable for a container. - **Security.Certificate.Path** configuration option value defines the path. [Security Configuration - Security.Certificate.Path](../../../server/configuration/security-configuration.mdx#security.certificate.path) + **Security.Certificate.Path** configuration option value defines the path. [Security Configuration - Security.Certificate.Path](../../../server/configuration/security-configuration.mdx#securitycertificatepath) - Script - A script that returns your certificate by any means. You can obtain it from container environmental variables, secured vault, secret, etc. - **Security.Certificate.Load.Exec** configuration option value defines the script path. [Security Configuration - Security.Certificate.Load.Exec](../../../server/configuration/security-configuration.mdx#security.certificate.load.exec) + **Security.Certificate.Load.Exec** configuration option value defines the script path. [Security Configuration - Security.Certificate.Load.Exec](../../../server/configuration/security-configuration.mdx#securitycertificateloadexec) These configuration options can be passed to RavenDB by settings.json, environmental variables, or command line arguments. See more here: [Configuration Options](../../../server/configuration/configuration-options.mdx) @@ -60,14 +60,14 @@ To enable it, set `Setup.Mode` configuration option to `LetsEncrypt`. Be aware that this automation will work **only when using Setup Wizard to obtain the LetsEncrypt certificate**, as RavenDB doesn't control your domain nor can access your backend used in the certificate load script. To learn more about this, visit this site: [RavenDB Lets Encrypt Certificates Docs](../../../server/security/authentication/lets-encrypt-certificates.mdx) -You can learn about different `Raven.SetupMode` values here: [Core Configuration - Setup.Mode](../../../server/configuration/core-configuration.mdx#setup.mode) +You can learn about different `Raven.SetupMode` values here: [Core Configuration - Setup.Mode](../../../server/configuration/core-configuration.mdx#setupmode) Also, you need to provide us with an email that you will use for the Let's Encrypt matter. Use `Security.Certificate.LetsEncrypt.Email`. #### Manual To configure manual certificate replacement and updates, write scripts to supply RavenDB configuration: -- [Security.Certificate.Renew.Exec](../../../server/configuration/security-configuration.mdx#security.certificate.renew.exec) -- [Security.Certificate.Change.Exec](../../../server/configuration/security-configuration.mdx#security.certificate.change.exec) +- [Security.Certificate.Renew.Exec](../../../server/configuration/security-configuration.mdx#securitycertificaterenewexec) +- [Security.Certificate.Change.Exec](../../../server/configuration/security-configuration.mdx#securitycertificatechangeexec) It will allow RavenDB to execute your routines, which should: diff --git a/versioned_docs/version-7.0/start/getting-started.mdx b/versioned_docs/version-7.0/start/getting-started.mdx index d53700322d..80754e0173 100644 --- a/versioned_docs/version-7.0/start/getting-started.mdx +++ b/versioned_docs/version-7.0/start/getting-started.mdx @@ -146,7 +146,7 @@ appearing: ### Configuration -The RavenDB server uses a [settings.json](../server/configuration/configuration-options.mdx#settings.json) file in each node `Server` folder to store the server-wide configuration options. +The RavenDB server uses a [settings.json](../server/configuration/configuration-options.mdx#settingsjson) file in each node `Server` folder to store the server-wide configuration options. When starting a server, RavenDB will look for the `settings.json` file in the node `Server` folder, so it must be located there. The [Setup Wizard](../start/installation/setup-wizard.mdx) places it correctly automatically. @@ -190,9 +190,9 @@ For a list of IPs and ports already in use, run `netstat -a` in the command line RavenDB requires write permissions to the following locations: -- The folder where RavenDB server is running (to update [settings.json](../server/configuration/configuration-options.mdx#settings.json) by the [Setup Wizard](../start/installation/setup-wizard.mdx)) +- The folder where RavenDB server is running (to update [settings.json](../server/configuration/configuration-options.mdx#settingsjson) by the [Setup Wizard](../start/installation/setup-wizard.mdx)) - The data folder ([`DataDir`](../server/configuration/core-configuration.mdx#datadir) setting) -- The logs folder ([`Logs.Path`](../server/configuration/logs-configuration.mdx#logs.path) setting) +- The logs folder ([`Logs.Path`](../server/configuration/logs-configuration.mdx#logspath) setting) If you intend to run as a service, the write permissions should be granted to the user running the service (e.g. "Local Service"). diff --git a/versioned_docs/version-7.0/start/installation/deployment-considerations.mdx b/versioned_docs/version-7.0/start/installation/deployment-considerations.mdx index 3b858f8919..8942c27bcd 100644 --- a/versioned_docs/version-7.0/start/installation/deployment-considerations.mdx +++ b/versioned_docs/version-7.0/start/installation/deployment-considerations.mdx @@ -100,7 +100,7 @@ permissions to the RavenDB directory and to the specified data directory. You ca On Linux, you'll typically run RavenDB as a daemon. The `install-daemon.sh` can handle the daemon registration for you (Ubuntu only). -In either case, you can configure RavenDB using the [settings.json](../../server/configuration/configuration-options.mdx#settings.json) file. The most important configurations are the data directory and the +In either case, you can configure RavenDB using the [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) file. The most important configurations are the data directory and the IPs and ports RavenDB will listen to. It is recommended that you'll pick the fastest drives for RavenDB's data directory, while the binaries for RavenDB can reside anywhere in the system. diff --git a/versioned_docs/version-7.0/start/installation/manual.mdx b/versioned_docs/version-7.0/start/installation/manual.mdx index bbb358cfbb..ba3894b45a 100644 --- a/versioned_docs/version-7.0/start/installation/manual.mdx +++ b/versioned_docs/version-7.0/start/installation/manual.mdx @@ -42,7 +42,7 @@ We recommend using multiple machines to improve [cluster availability via failov By default, when a server is started using `run.ps1` (or `run.sh` in Linux) script. It will open a browser with a [Setup Wizard](../../start/installation/setup-wizard.mdx) which will guide you through the server configuration process. -The setup is started because the default configuration file [settings.json](../../server/configuration/configuration-options.mdx#settings.json) (found in the downloaded RavenDB Server package inside the **Server** folder) comes configured like this: +The setup is started because the default configuration file [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) (found in the downloaded RavenDB Server package inside the **Server** folder) comes configured like this: @@ -93,5 +93,5 @@ Read the [Manual Certificate Configuration](../../server/security/authentication ## Configuration -Read the [Configuration Section](../../server/configuration/configuration-options.mdx) to learn more about using [settings.json](../../server/configuration/configuration-options.mdx#settings.json) and see a list of configuration options. +Read the [Configuration Section](../../server/configuration/configuration-options.mdx) to learn more about using [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) and see a list of configuration options. diff --git a/versioned_docs/version-7.0/start/installation/setup-examples/aws-linux-vm.mdx b/versioned_docs/version-7.0/start/installation/setup-examples/aws-linux-vm.mdx index 1f9dbc372b..6faa8e41a9 100644 --- a/versioned_docs/version-7.0/start/installation/setup-examples/aws-linux-vm.mdx +++ b/versioned_docs/version-7.0/start/installation/setup-examples/aws-linux-vm.mdx @@ -132,7 +132,7 @@ Locate the VM's private and public IP addresses in the AWS EC2 Management Consol You have a few choices on how to run the RavenDB server. We will use the [Setup Wizard](../../../start/installation/setup-wizard.mdx), but you can also configure things [manually](../../../start/installation/manual.mdx). -Let's edit the [settings.json](../../../server/configuration/configuration-options.mdx#settings.json) file so that we can perform the setup remotely using the browser. +Let's edit the [settings.json](../../../server/configuration/configuration-options.mdx#settingsjson) file so that we can perform the setup remotely using the browser. Notice that when we run the server for the first time, `settings.json` is created from `settings.default.json`. So if `settings.json` doesn't exist, edit `settings.default.json` instead. @@ -236,7 +236,7 @@ Access the certificate view to see both the loaded server certificate and the ad Congratulations! You have a secure RavenDB server running on a simple EC2 machine. -Don't forget to delete the `Security.UnsecuredAccessAllowed` property from [settings.json](../../../server/configuration/configuration-options.mdx#settings.json). It's not necessary anymore because access to the server now requires using a registered client certificate. +Don't forget to delete the `Security.UnsecuredAccessAllowed` property from [settings.json](../../../server/configuration/configuration-options.mdx#settingsjson). It's not necessary anymore because access to the server now requires using a registered client certificate. Connecting a few servers in a cluster is easy. Follow [these instructions](../../../start/installation/setup-wizard.mdx) to construct a cluster during setup. diff --git a/versioned_docs/version-7.0/start/installation/setup-wizard.mdx b/versioned_docs/version-7.0/start/installation/setup-wizard.mdx index 4b8fc9832a..615c4a4953 100644 --- a/versioned_docs/version-7.0/start/installation/setup-wizard.mdx +++ b/versioned_docs/version-7.0/start/installation/setup-wizard.mdx @@ -148,7 +148,7 @@ All 3 nodes will run on the local machine: - Node B (https://b.raven.development.run) will listen to 127.0.0.2 on port 8080. - Node C (https://c.raven.development.run) will listen to 127.0.0.3 on port 8080. -Each node will run in its own process and have its own data directory and [settings.json](../../server/configuration/configuration-options.mdx#settings.json) file. +Each node will run in its own process and have its own data directory and [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) file. You should have 3 separate RavenDB node folders. ### Example II - On separate machines for higher availability @@ -423,7 +423,7 @@ All 3 nodes will run on the local machine: - Node B (https://b.ravendb.example.com) will listen to 127.0.0.2 on port 8080. - Node C (https://c.ravendb.example.com) will listen to 127.0.0.3 on port 8080. -Each node will run in its own process and have its own data directory and [settings.json](../../server/configuration/configuration-options.mdx#settings.json) file. +Each node will run in its own process and have its own data directory and [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) file. ### Example II - On separate machines diff --git a/versioned_docs/version-7.0/start/installation/upgrading-to-new-version.mdx b/versioned_docs/version-7.0/start/installation/upgrading-to-new-version.mdx index 87dcbbb78c..4b53fe4cd7 100644 --- a/versioned_docs/version-7.0/start/installation/upgrading-to-new-version.mdx +++ b/versioned_docs/version-7.0/start/installation/upgrading-to-new-version.mdx @@ -30,7 +30,7 @@ Upgrading a RavenDB instance to a new version is very simple. To do so: 3. Remove old RavenDB binaries * **Avoid** deleting your actual data, contained in folders like `RavenData`. - * **Avoid** overwriting your configuration files, e.g. [settings.json](../../server/configuration/configuration-options.mdx#settings.json). + * **Avoid** overwriting your configuration files, e.g. [settings.json](../../server/configuration/configuration-options.mdx#settingsjson). * **Avoid** deleting your certificate file (ending with `.pfx` or `.pem`). * For additional information see the [certificate page](../../server/security/authentication/certificate-configuration.mdx). * These steps are strictly necessary when updating to version 5.1. @@ -71,7 +71,7 @@ or [External replication](../../studio/database/tasks/ongoing-tasks/external-rep Please read the [migration article](../../migration/server/data-migration.mdx) for additional data and client migration strategies. * If you have a license for a RavenDB version older than `6.x`, upgrading to version `6.0` will require you to upgrade your license key. - * Read [here](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6.x) how to upgrade + * Read [here](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6x) how to upgrade and replace your existing license key. * Read [here](../../migration/server/data-migration.mdx) about migrating from one RavenDB version to another. diff --git a/versioned_docs/version-7.0/start/licensing/activate-license.mdx b/versioned_docs/version-7.0/start/licensing/activate-license.mdx index 9233c49897..211a51235b 100644 --- a/versioned_docs/version-7.0/start/licensing/activate-license.mdx +++ b/versioned_docs/version-7.0/start/licensing/activate-license.mdx @@ -30,7 +30,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * You can activate the license using either one of the following configuration keys: * [License](../../server/configuration/license-configuration.mdx#license) - * [License.Path](../../server/configuration/license-configuration.mdx#license.path) + * [License.Path](../../server/configuration/license-configuration.mdx#licensepath) * These configuration keys can be set in _setting.json_ or as environment variables. Learn more in [configuration overview](../../server/configuration/configuration-options.mdx). diff --git a/versioned_docs/version-7.0/start/licensing/force-update.mdx b/versioned_docs/version-7.0/start/licensing/force-update.mdx index 50f5eb785b..b9e03e3070 100644 --- a/versioned_docs/version-7.0/start/licensing/force-update.mdx +++ b/versioned_docs/version-7.0/start/licensing/force-update.mdx @@ -21,7 +21,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * This automatic update will be applied provided that: * You have an active connection to RavenDB's License Server (api.ravendb.net). - * [DisableAutoUpdate](../../server/configuration/license-configuration.mdx#license.disableautoupdate) is set to false. + * [DisableAutoUpdate](../../server/configuration/license-configuration.mdx#licensedisableautoupdate) is set to false. * If changes were made to your current license and you want to **apply immediately**, then you can **force the update from Studio**. @@ -43,7 +43,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * Click the _Force Update_ button. This will update your current license immediately. - * If [DisableAutoUpdateFromApi](../../server/configuration/license-configuration.mdx#license.disableautoupdatefromapi) is set to _true_, + * If [DisableAutoUpdateFromApi](../../server/configuration/license-configuration.mdx#licensedisableautoupdatefromapi) is set to _true_, the license will be updated from the [configuration keys](../../start/licensing/activate-license.mdx#activate-license-with-configuration-keys). If set to _false_, the license will be updated from the [License Server](../../start/licensing/licensing-overview.mdx#license-server), provided you have an active connection. diff --git a/versioned_docs/version-7.0/start/licensing/renew-license.mdx b/versioned_docs/version-7.0/start/licensing/renew-license.mdx index 26e584a50b..2f7da0cd33 100644 --- a/versioned_docs/version-7.0/start/licensing/renew-license.mdx +++ b/versioned_docs/version-7.0/start/licensing/renew-license.mdx @@ -34,7 +34,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; **Automatic renewal**: If your server has an active connection to RavenDB's [License Server](../../start/licensing/licensing-overview.mdx#license-server), -and if the [DisableAutoUpdate](../../server/configuration/license-configuration.mdx#license.disableautoupdate) configuration is Not set to true, +and if the [DisableAutoUpdate](../../server/configuration/license-configuration.mdx#licensedisableautoupdate) configuration is Not set to true, then these commercial licenses will be automatically renewed. @@ -50,7 +50,7 @@ Copy the new license key from the mail and proceed with one of the following opt **Or**: -* Set [DisableAutoUpdateFromApi](../../server/configuration/license-configuration.mdx#license.disableautoupdatefromapi) to true. +* Set [DisableAutoUpdateFromApi](../../server/configuration/license-configuration.mdx#licensedisableautoupdatefromapi) to true. * Activate the new license key using the [configuration keys](../../start/licensing/activate-license.mdx#activate-license-with-configuration-keys). diff --git a/versioned_docs/version-7.0/start/licensing/replace-license.mdx b/versioned_docs/version-7.0/start/licensing/replace-license.mdx index 8176427693..d57625f066 100644 --- a/versioned_docs/version-7.0/start/licensing/replace-license.mdx +++ b/versioned_docs/version-7.0/start/licensing/replace-license.mdx @@ -22,13 +22,13 @@ 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-6.x) + as explained [below](../../start/licensing/replace-license.mdx#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) * [Maintain auto-renewal of Let's Encrypt certificates](../../start/licensing/replace-license.mdx#maintain-auto-renewal-of-let) - * [Upgrade a License Key For RavenDB 6.x](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6.x) + * [Upgrade a License Key For RavenDB 6.x](../../start/licensing/replace-license.mdx#upgrade-a-license-key-for-ravendb-6x) ## Replace license from Studio diff --git a/versioned_docs/version-7.0/studio/database/create-new-database/from-backup.mdx b/versioned_docs/version-7.0/studio/database/create-new-database/from-backup.mdx index c121451f55..00cd20edfb 100644 --- a/versioned_docs/version-7.0/studio/database/create-new-database/from-backup.mdx +++ b/versioned_docs/version-7.0/studio/database/create-new-database/from-backup.mdx @@ -49,7 +49,7 @@ Another way to access the New Database From Backup interface is via the Studio B ![Figure 2. Backup Source Configuration](./assets/new-database-from-backup-2.png) -1. [**Name** your new database](../../../studio/database/create-new-database/general-flow.mdx#2.-database-name). +1. [**Name** your new database](../../../studio/database/create-new-database/general-flow.mdx#2-database-name). 2. **Source** Select the source server type to see the fields necessary to access the backup diff --git a/versioned_docs/version-7.0/studio/database/create-new-database/from-legacy-files.mdx b/versioned_docs/version-7.0/studio/database/create-new-database/from-legacy-files.mdx index 44408be261..3ee0677ebc 100644 --- a/versioned_docs/version-7.0/studio/database/create-new-database/from-legacy-files.mdx +++ b/versioned_docs/version-7.0/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](../../../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 @@ -35,7 +35,7 @@ Open the down arrow and click `New database from legacy files`. ![Figure 2. Create New Database From Legacy Files - Data Source Configuration](./assets/new-database-from-legacy-2.png) -1. [Database Name](../../../studio/database/create-new-database/general-flow.mdx#2.-database-name) +1. [Database Name](../../../studio/database/create-new-database/general-flow.mdx#2-database-name) 2. **Resource type** * RavenFS files will be saved as documents with attachments in @files collection. diff --git a/versioned_docs/version-7.0/studio/database/create-new-database/general-flow.mdx b/versioned_docs/version-7.0/studio/database/create-new-database/general-flow.mdx index c7727ebcbd..de1fcc3b13 100644 --- a/versioned_docs/version-7.0/studio/database/create-new-database/general-flow.mdx +++ b/versioned_docs/version-7.0/studio/database/create-new-database/general-flow.mdx @@ -16,7 +16,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](../../../studio/database/create-new-database/general-flow.mdx#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). @@ -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](../../../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 diff --git a/versioned_docs/version-7.0/studio/database/documents/patch-view.mdx b/versioned_docs/version-7.0/studio/database/documents/patch-view.mdx index d6a0caaf2a..8eaa43b152 100644 --- a/versioned_docs/version-7.0/studio/database/documents/patch-view.mdx +++ b/versioned_docs/version-7.0/studio/database/documents/patch-view.mdx @@ -124,7 +124,7 @@ update \{ * d. **Ignore maximum number of steps for script** By default, a patch script can execute up to a maximum number of steps before throwing an exception. - This limit is set by the [Patching.MaxStepsForScript](../../../server/configuration/patching-configuration.mdx#patching.maxstepsforscript) configuration key (default: 10,000). + This limit is set by the [Patching.MaxStepsForScript](../../../server/configuration/patching-configuration.mdx#patchingmaxstepsforscript) configuration key (default: 10,000). Toggle this option ON to ignore the limit. * e. **Limit number of operations** diff --git a/versioned_docs/version-7.0/studio/database/indexes/indexing-performance.mdx b/versioned_docs/version-7.0/studio/database/indexes/indexing-performance.mdx index e7d769edf0..534ac5240a 100644 --- a/versioned_docs/version-7.0/studio/database/indexes/indexing-performance.mdx +++ b/versioned_docs/version-7.0/studio/database/indexes/indexing-performance.mdx @@ -171,7 +171,7 @@ Indexing can be a taxing operation on CPU resources. There are a number of [configurations](../../../server/configuration/indexing-configuration.mdx) that efficiently use batch stops to break up huge batch processes into smaller batches to prevent exhausting resources. If a configuration is specific to an index, it can be [set in the Studio](../../../studio/database/indexes/create-map-index.mdx#configuration). -If it is a server-wide only configuration, it must be set in the server's [settings.json](../../../server/configuration/configuration-options.mdx#settings.json). +If it is a server-wide only configuration, it must be set in the server's [settings.json](../../../server/configuration/configuration-options.mdx#settingsjson). While they prevent system exhaustion, batch stops also point to potential **opportunities to optimize** your indexes. @@ -188,18 +188,18 @@ Some indexes are responsible for a huge dataset and/or have very complex, demand 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: -- [Indexing.MapTimeoutInSec](../../../server/configuration/indexing-configuration.mdx#indexing.maptimeoutinsec) +- [Indexing.MapTimeoutInSec](../../../server/configuration/indexing-configuration.mdx#indexingmaptimeoutinsec) Number of seconds after which mapping will end even if there is more to map. -- [Indexing.MapTimeoutAfterEtagReachedInMin](../../../server/configuration/indexing-configuration.mdx#indexing.maptimeoutafteretagreachedinmin) +- [Indexing.MapTimeoutAfterEtagReachedInMin](../../../server/configuration/indexing-configuration.mdx#indexingmaptimeoutafteretagreachedinmin) This will only be applied if we pass the last [etag](../../../glossary/etag.mdx) in collection that we saw when batch was started. -- [Indexing.MapBatchSize](../../../server/configuration/indexing-configuration.mdx#indexing.mapbatchsize) +- [Indexing.MapBatchSize](../../../server/configuration/indexing-configuration.mdx#indexingmapbatchsize) Maximum number of documents to be processed by the index per indexing batch. #### Low Memory -* [Low Memory](../../../server/configuration/memory-configuration.mdx#memory.lowmemorylimitinmb) 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](../../../studio/database/indexes/indexing-performance.mdx#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#indexing.mapbatchsize) that you can configure + * Until then, there are a number of [indexing configurations](../../../server/configuration/indexing-configuration.mdx#indexingmapbatchsize) that you can configure to break up processes into smaller batches. * **Cloud server** Your indexing process will continue until it is finished, but will be broken up into smaller batches and continue when enough CPU credits accumulate. @@ -213,7 +213,7 @@ You can configure [batch stops](../../../studio/database/indexes/indexing-perfor [externally replicate](../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx) to new instances, and/or optimize your indexes. #### Concurrent Processing of Too Many Indexes -- [Limit concurrent index processes](../../../server/configuration/indexing-configuration.mdx#indexing.maxnumberofconcurrentlyrunningindexes) - +- [Limit concurrent index processes](../../../server/configuration/indexing-configuration.mdx#indexingmaxnumberofconcurrentlyrunningindexes) - RavenDB can handle multiple index processes at the same time, but if there are too many, it will exhaust the system resources and cause a noticeable slow-down. The `Indexing.MaxNumberOfConcurrentlyRunningIndexes` method enables you to have many indexes without exhausting resources by allowing you to set the number of concurrent index processes. diff --git a/versioned_docs/version-7.0/studio/database/settings/database-settings.mdx b/versioned_docs/version-7.0/studio/database/settings/database-settings.mdx index bb1d986fe6..72f050e5af 100644 --- a/versioned_docs/version-7.0/studio/database/settings/database-settings.mdx +++ b/versioned_docs/version-7.0/studio/database/settings/database-settings.mdx @@ -57,7 +57,7 @@ Do not modify the database settings unless you are an expert and know what you'r * Only the **database scope** configuration keys can be edited from this view. Configuration keys that relate only to the **server scope** are edited in the - [`settings.json` file](../../../server/configuration/configuration-options.mdx#settings.json) + [`settings.json` file](../../../server/configuration/configuration-options.mdx#settingsjson) and can only be viewed here. * Once you save the changes made in this view, all modifications are saved into the @@ -73,7 +73,7 @@ Do not modify the database settings unless you are an expert and know what you'r 3. This column lists the **Configuration Keys** in the selected Category. 4. This column lists the current **Value** set for the key. 5. The lock icon indicates that this key is server scoped and can not be modified here. - It can be edited only from the [`settings.json` file](../../../server/configuration/configuration-options.mdx#settings.json) + It can be edited only from the [`settings.json` file](../../../server/configuration/configuration-options.mdx#settingsjson) located in your RavenDB executable folder. 6. Toggle to override the current value of this key. 7. Use the edit box to customize the value. diff --git a/versioned_docs/version-7.0/studio/database/settings/documents-compression.mdx b/versioned_docs/version-7.0/studio/database/settings/documents-compression.mdx index 050160aea3..441a93e869 100644 --- a/versioned_docs/version-7.0/studio/database/settings/documents-compression.mdx +++ b/versioned_docs/version-7.0/studio/database/settings/documents-compression.mdx @@ -20,7 +20,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; Learn more in this [overview](../../../server/storage/documents-compression.mdx#overview). * Documents compression can be set for all collections, selected collections, and revisions. - Default compression settings are [configurable](../../../server/configuration/database-configuration.mdx#databases.compression.compressallcollectionsdefault). + Default compression settings are [configurable](../../../server/configuration/database-configuration.mdx#databasescompressioncompressallcollectionsdefault). * When turned on, compression will be applied to: * **New documents**: diff --git a/versioned_docs/version-7.0/studio/database/settings/studio-configuration.mdx b/versioned_docs/version-7.0/studio/database/settings/studio-configuration.mdx index c528fd6ec7..dd203aa8e7 100644 --- a/versioned_docs/version-7.0/studio/database/settings/studio-configuration.mdx +++ b/versioned_docs/version-7.0/studio/database/settings/studio-configuration.mdx @@ -18,9 +18,9 @@ import LanguageContent from "@site/src/components/LanguageContent"; * The Studio Configuration view enables configuration of studio-related operations and interfaces. * Settings changed in this view do not change configurations in other scopes such as Client or Server API. - * To disable the creation of Auto-Indexes in other scopes, set [Indexing.DisableQueryOptimizerGeneratedIndexes](../../../server/configuration/indexing-configuration.mdx#indexing.disablequeryoptimizergeneratedindexes) + * To disable the creation of Auto-Indexes in other scopes, set [Indexing.DisableQueryOptimizerGeneratedIndexes](../../../server/configuration/indexing-configuration.mdx#indexingdisablequeryoptimizergeneratedindexes) to `true`: - * Server-wide - set it in the server's [settings.json](../../../server/configuration/configuration-options.mdx#settings.json) file. + * Server-wide - set it in the server's [settings.json](../../../server/configuration/configuration-options.mdx#settingsjson) file. * Per database - set it in the database's [Document Store](../../../client-api/operations/maintenance/configuration/database-settings-operation.mdx). In this page: @@ -88,9 +88,9 @@ In this page: * Note: dynamic queries can be issued either when [querying](../../../studio/database/queries/query-view.mdx#query-view) or when [patching](../../../studio/database/documents/patch-view.mdx#patch-configuration). * Auto-indexes are dynamically maintained to change automatically in response to changing query demands. - After a certain amount of time that an auto-index is not used [(30 minutes by default)](../../../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforemarkingautoindexasidleinmin), + After a certain amount of time that an auto-index is not used [(30 minutes by default)](../../../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforemarkingautoindexasidleinmin), the index goes into an [idle state](../../../studio/database/indexes/indexes-list-view.mdx#index-state) - and deleted after a set time-period [(72 hours by default)](../../../server/configuration/indexing-configuration.mdx#indexing.timetowaitbeforedeletingautoindexmarkedasidleinhrs). + and deleted after a set time-period [(72 hours by default)](../../../server/configuration/indexing-configuration.mdx#indexingtimetowaitbeforedeletingautoindexmarkedasidleinhrs). * To provide for fast queries, indexes process information in the background. If they are processing large datasets, each index can be demanding on I/O resources. @@ -114,7 +114,7 @@ temporarily allow Auto-Index in the Query or Patch settings interface. Note: These settings only affect Auto-Indexing as a result of Queries or Patches done in the Studio. They do not affect API-based Queries or Patches. -To configure API-based Auto-Indexing, see [Indexing.DisableQueryOptimizerGeneratedIndexes](../../../server/configuration/indexing-configuration.mdx#indexing.disablequeryoptimizergeneratedindexes) +To configure API-based Auto-Indexing, see [Indexing.DisableQueryOptimizerGeneratedIndexes](../../../server/configuration/indexing-configuration.mdx#indexingdisablequeryoptimizergeneratedindexes) @@ -132,7 +132,7 @@ To configure API-based Auto-Indexing, see [Indexing.DisableQueryOptimizerGenerat Choose work environment. This does not affect settings or features. It makes it clear if, for example, you are in a production server and should be much more careful than in a development environment. 4. **Default replication factor** - Change the default [replication factor](../../../studio/database/create-new-database/general-flow.mdx#3.-configure-replication) from + Change the default [replication factor](../../../studio/database/create-new-database/general-flow.mdx#3-configure-replication) from automatically replicating data to every node in the cluster. 5. **Help us improve the Studio** Allow the Studio to send usage statistics to inform our developers. diff --git a/versioned_docs/version-7.0/studio/database/tasks/create-sample-data.mdx b/versioned_docs/version-7.0/studio/database/tasks/create-sample-data.mdx index 127346a8f8..84819a1b63 100644 --- a/versioned_docs/version-7.0/studio/database/tasks/create-sample-data.mdx +++ b/versioned_docs/version-7.0/studio/database/tasks/create-sample-data.mdx @@ -34,7 +34,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * To create sample data, you can either empty your playground database or [create a new database](../../../studio/database/create-new-database/general-flow.mdx). -* If you plan to use [multiple nodes](../../../studio/database/create-new-database/general-flow.mdx#3.-configure-replication) +* If you plan to use [multiple nodes](../../../studio/database/create-new-database/general-flow.mdx#3-configure-replication) and/or [encryption](../../../studio/database/create-new-database/encrypted.mdx) in production, we recommend installing your playground database in a similar environment. diff --git a/versioned_docs/version-7.0/studio/database/tasks/import-data/import-from-other.mdx b/versioned_docs/version-7.0/studio/database/tasks/import-data/import-from-other.mdx index e8ddbd8f2c..8a333adac3 100644 --- a/versioned_docs/version-7.0/studio/database/tasks/import-data/import-from-other.mdx +++ b/versioned_docs/version-7.0/studio/database/tasks/import-data/import-from-other.mdx @@ -25,7 +25,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; * In this page: - * [Download Raven.Migrator Tool](../../../../studio/database/tasks/import-data/import-from-other.mdx#download-raven.migrator-tool) + * [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) @@ -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-raven.migrator-tool). + * Find `Raven.Migrator.exe` in the [tools package](../../../../studio/database/tasks/import-data/import-from-other.mdx#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-raven.migrator-tool). + * Find `Raven.Migrator.exe` in the [tools package](../../../../studio/database/tasks/import-data/import-from-other.mdx#download-ravenmigrator-tool). * Provide a path to `Raven.Migrator.exe`'s folder. 2. **Database Source** diff --git a/versioned_docs/version-7.0/studio/server/certificates/server-management-certificates-view.mdx b/versioned_docs/version-7.0/studio/server/certificates/server-management-certificates-view.mdx index 01edc5b42d..14e7642e01 100644 --- a/versioned_docs/version-7.0/studio/server/certificates/server-management-certificates-view.mdx +++ b/versioned_docs/version-7.0/studio/server/certificates/server-management-certificates-view.mdx @@ -44,7 +44,7 @@ the permissions entirely using this view. * [Export server certificates](../../../server/security/authentication/certificate-management.mdx#export-server-certificates) so that you can import them into another server. * [Replace server certificates](../../../server/security/authentication/certificate-renewal-and-rotation.mdx) by uploading another `.pfx` certificate. 5. **Well known admin certificate** - This is a trusted certificate, [defined by a system administrator](../../../server/configuration/security-configuration.mdx#security.wellknowncertificates.admin) + This is a trusted certificate, [defined by a system administrator](../../../server/configuration/security-configuration.mdx#securitywellknowncertificatesadmin) and given admin permissions. 6. **Server certificate** You can click [Renew now](../../../server/security/authentication/certificate-renewal-and-rotation.mdx) here. diff --git a/versioned_docs/version-7.0/studio/server/server-settings.mdx b/versioned_docs/version-7.0/studio/server/server-settings.mdx index 1bf4ef1d58..8f566ba1fd 100644 --- a/versioned_docs/version-7.0/studio/server/server-settings.mdx +++ b/versioned_docs/version-7.0/studio/server/server-settings.mdx @@ -19,7 +19,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; hosted by the server. * This is a **read-only** view, showing settings made using [environment variables](../../server/configuration/configuration-options.mdx#environment-variables), - the [settings.json](../../server/configuration/configuration-options.mdx#settings.json) + the [settings.json](../../server/configuration/configuration-options.mdx#settingsjson) configuration file, and [command line arguments](../../server/configuration/configuration-options.mdx#command-line-arguments). * For the server settings view open **Manage Server** `>>` **Server Settings** * To modify the settings of individual databases use the [Database Settings](../../studio/database/settings/database-settings.mdx) view.