DOC-648 | Stable multi-dimensional indexes

site/content/3.10/develop/http-api/indexes/fulltext.md

@@ -5,7 +5,6 @@ weight: 30
 description: ''
 archetype: default
 ---
-
 ## Create a full-text index
 
 ```openapi

site/content/3.10/develop/http-api/indexes/geo-spatial.md

@@ -5,7 +5,6 @@ weight: 25
 description: ''
 archetype: default
 ---
-
 ## Create a geo-spatial index
 
 ```openapi

site/content/3.10/develop/http-api/indexes/multi-dimensional.md

@@ -5,7 +5,6 @@ weight: 20
 description: ''
 archetype: default
 ---
-
 ## Create a multi-dimensional index
 
 ```openapi

site/content/3.10/develop/http-api/indexes/ttl.md

@@ -5,7 +5,6 @@ weight: 15
 description: ''
 archetype: default
 ---
-
 ## Create a TTL index
 
 ```openapi

site/content/3.10/develop/http-api/replication/other-replication-commands.md

@@ -5,7 +5,6 @@ weight: 20
 description: ''
 archetype: default
 ---
-
 ## Get the replication server ID
 
 ```openapi

site/content/3.10/index-and-search/indexing/working-with-indexes/multi-dimensional-indexes.md

@@ -7,15 +7,26 @@ description: >-
   such as time ranges, for efficient intersection of multiple range queries
 archetype: default
 ---
-The multi-dimensional index type is called **ZKD**.
+A multi-dimensional index maps multi-dimensional data in the form of multiple
+numeric attributes to one dimension while mostly preserving locality so that
+similar values in all of the dimensions remain close to each other in the mapping
+to a single dimension. Queries that filter by multiple value ranges at once can
+be better accelerated with such an index compared to a persistent index.
+
+The multi-dimensional index type is called `zkd`.
 
 {{< warning >}}
 `zkd` indexes are an **experimental** feature.
 {{< /warning >}}
 
-A multi-dimensional index is setup by setting the index type to `"zkd"`.
-The `fields` attribute describes which fields are used as dimensions.
-The value of each dimension has to be a numeric (double) value.
+
+The `fields` property of a `zkd` index describes which document attributes to
+use as dimensions. It is required that the attributes are present and have
+numeric values.
+
+Multi-dimensional indexes can be declared as `unique` to only allow a single
+document with a given combination of attribute values, using all of the `fields`
+attributes.
 
 ## Querying documents within a 3D box
 

site/content/3.10/release-notes/version-3.10/api-changes-in-3-10.md

@@ -766,16 +766,15 @@ figures, and for `arangosearch` Views, `withHidden` needs to be enabled, too:
 
 <small>Introduced in: v3.10.13</small>
 
-The `GET /_api/index` endpoint now returns a `progress` attribute that can
-optionally show indexes that are currently being created and indicate progress
-on the index generation.
+The `GET /_api/index` endpoint may now include a `progress` attribute for the
+elements in the `indexes` array. For every index that is currently being created,
+it indicates the progress of the index generation (in percent).
 
 To return indexes that are not yet fully built but are in the building phase,
-add the option `withHidden=true` to `GET /_api/index?collection=<collectionName>`.
+add the `withHidden=true` query parameter to the call of the endpoint.
 
 ```
-curl --header 'accept: application/json' --dump -
-"http://localhost:8529/_api/index?collection=myCollection&withHidden=true"
+curl "http://localhost:8529/_api/index?collection=myCollection&withHidden=true"
 ```
 
 #### Document API

site/content/3.11/develop/http-api/indexes/fulltext.md

@@ -5,7 +5,6 @@ weight: 30
 description: ''
 archetype: default
 ---
-
 ## Create a full-text index
 
 ```openapi

site/content/3.11/develop/http-api/indexes/geo-spatial.md

@@ -5,7 +5,6 @@ weight: 25
 description: ''
 archetype: default
 ---
-
 ## Create a geo-spatial index
 
 ```openapi

site/content/3.11/develop/http-api/indexes/inverted.md

@@ -5,7 +5,6 @@ weight: 10
 description: ''
 archetype: default
 ---
-
 ## Create an inverted index
 
 ```openapi

site/content/3.11/develop/http-api/indexes/multi-dimensional.md

@@ -5,7 +5,6 @@ weight: 20
 description: ''
 archetype: default
 ---
-
 ## Create a multi-dimensional index
 
 ```openapi

site/content/3.11/develop/http-api/indexes/ttl.md

@@ -5,7 +5,6 @@ weight: 15
 description: ''
 archetype: default
 ---
-
 ## Create a TTL index
 
 ```openapi

site/content/3.11/develop/http-api/replication/other-replication-commands.md

@@ -5,7 +5,6 @@ weight: 20
 description: ''
 archetype: default
 ---
-
 ## Get the replication server ID
 
 ```openapi

site/content/3.11/index-and-search/indexing/working-with-indexes/multi-dimensional-indexes.md

@@ -7,15 +7,26 @@ description: >-
   such as time ranges, for efficient intersection of multiple range queries
 archetype: default
 ---
-The multi-dimensional index type is called **ZKD**.
+A multi-dimensional index maps multi-dimensional data in the form of multiple
+numeric attributes to one dimension while mostly preserving locality so that
+similar values in all of the dimensions remain close to each other in the mapping
+to a single dimension. Queries that filter by multiple value ranges at once can
+be better accelerated with such an index compared to a persistent index.
+
+The multi-dimensional index type is called `zkd`.
 
 {{< warning >}}
 `zkd` indexes are an **experimental** feature.
 {{< /warning >}}
 
-A multi-dimensional index is setup by setting the index type to `"zkd"`.
-The `fields` attribute describes which fields are used as dimensions.
-The value of each dimension has to be a numeric (double) value.
+
+The `fields` property of a `zkd` index describes which document attributes to
+use as dimensions. It is required that the attributes are present and have
+numeric values.
+
+Multi-dimensional indexes can be declared as `unique` to only allow a single
+document with a given combination of attribute values, using all of the `fields`
+attributes.
 
 ## Querying documents within a 3D box
 

site/content/3.11/release-notes/version-3.10/api-changes-in-3-10.md

@@ -766,16 +766,15 @@ figures, and for `arangosearch` Views, `withHidden` needs to be enabled, too:
 
 <small>Introduced in: v3.10.13</small>
 
-The `GET /_api/index` endpoint now returns a `progress` attribute that can
-optionally show indexes that are currently being created and indicate progress
-on the index generation.
+The `GET /_api/index` endpoint may now include a `progress` attribute for the
+elements in the `indexes` array. For every index that is currently being created,
+it indicates the progress of the index generation (in percent).
 
 To return indexes that are not yet fully built but are in the building phase,
-add the option `withHidden=true` to `GET /_api/index?collection=<collectionName>`.
+add the `withHidden=true` query parameter to the call of the endpoint.
 
 ```
-curl --header 'accept: application/json' --dump -
-"http://localhost:8529/_api/index?collection=myCollection&withHidden=true"
+curl "http://localhost:8529/_api/index?collection=myCollection&withHidden=true"
 ```
 
 #### Document API

site/content/3.11/release-notes/version-3.11/api-changes-in-3-11.md

@@ -484,17 +484,16 @@ and [Monitoring per collection/database/user](../version-3.11/whats-new-in-3-11.
 
 <small>Introduced in: v3.10.13, v3.11.7</small>
 
-The `GET /_api/index` endpoint now returns a `progress` attribute that can
-optionally show indexes that are currently being created and indicate progress
-on the index generation.
+The `GET /_api/index` endpoint may now include a `progress` attribute for the
+elements in the `indexes` array. For every index that is currently being created,
+it indicates the progress of the index generation (in percent).
 
 To return indexes that are not yet fully built but are in the building phase,
-add the option `withHidden=true` to `GET /_api/index?collection=<collectionName>`.
+add the `withHidden=true` query parameter to the call of the endpoint.
 
 ```
-curl --header 'accept: application/json' --dump -
-"http://localhost:8529/_api/index?collection=myCollection&withHidden=true"
-```  
+curl "http://localhost:8529/_api/index?collection=myCollection&withHidden=true"
+```
 
 ### Endpoints deprecated
 

site/content/3.12/about-arangodb/features/community-edition.md

@@ -196,11 +196,9 @@ see [arangodb.com/community-server/](https://www.arangodb.com/community-server/)
   the S2 library. <!-- TODO: list supported queries? Centroid-limitations? -->
   Support for composable, distance-based geo-queries ("geo cursors").
 
-{{% comment %}} Experimental feature
 - [**Multi-dimensional indexes**](../../index-and-search/indexing/working-with-indexes/multi-dimensional-indexes.md):
   An index type to efficiently intersect multiple range queries, like finding
   all appointments that intersect a time range.
-{{% /comment %}}
 
 - [**Background Indexing**](../../index-and-search/indexing/basics.md#creating-indexes-in-background):
   Indexes can be created in the background to not block queries in the meantime.

site/content/3.12/about-arangodb/features/highlights-by-version.md

@@ -17,6 +17,10 @@ aliases:
   Accelerate wildcard searches against Views and inverted indexes with _n_-grams
   to quickly find candidate matches.
 
+- [**Multi-dimensional indexes**](../../index-and-search/indexing/working-with-indexes/multi-dimensional-indexes.md):
+  An index type to efficiently intersect multiple range queries, like finding
+  all appointments that intersect a time range.
+
 - [**External versioning**](../../release-notes/version-3.12/whats-new-in-3-12.md#external-versioning-support):
   Specify any top-level attribute to compare whether the version number is higher
   than the currently stored one when updating or replacing documents.

site/content/3.12/aql/high-level-operations/for.md

@@ -240,8 +240,8 @@ Also see [Caching of index values](../../index-and-search/indexing/working-with-
 
 ### `lookahead`
 
-The multi-dimensional index type `zkd` supports an optional index hint for
-tweaking performance:
+The multi-dimensional index types `mdi` and `mdi-prefixed` support an optional
+index hint for tweaking performance:
 
 ```aql
 FOR … IN … OPTIONS { lookahead: 32 }

site/content/3.12/develop/http-api/indexes/fulltext.md

@@ -5,7 +5,6 @@ weight: 30
 description: ''
 archetype: default
 ---
-
 ## Create a full-text index
 
 ```openapi

site/content/3.12/develop/http-api/indexes/geo-spatial.md

@@ -5,7 +5,6 @@ weight: 25
 description: ''
 archetype: default
 ---
-
 ## Create a geo-spatial index
 
 ```openapi

site/content/3.12/develop/http-api/indexes/inverted.md

@@ -5,7 +5,6 @@ weight: 10
 description: ''
 archetype: default
 ---
-
 ## Create an inverted index
 
 ```openapi