Merge pull request #501 from arangodb/release-3.12.0

ansoboleva · web-flow · commit a1f6a39c5d1e · 2024-03-23T15:36:17.000+01:00
DOC-677 | 3.12.0 release
diff --git a/CIRCLECI.md b/CIRCLECI.md
@@ -172,7 +172,7 @@ steps below.
 | string | `workflow` | `release` |
 | string | `release-type` | `arangodb` |
 | string | `docs-version` | `3.11` (the docs version folder) |
-| string | `arangodb-branch` | `3.11` (the arangodb/arangodb branch to compile) |
+| string | `arangodb-branch` | `3.11.4` (the arangodb/arangodb branch to compile) |
 | string | `arangodb-version` | `3.11.4` (updates the `versions.yaml` file) |
 
 The ArangoDB release workflow includes the following jobs:
diff --git a/site/content/3.10/develop/http-api/indexes/_index.md b/site/content/3.10/develop/http-api/indexes/_index.md
@@ -54,7 +54,8 @@ paths:
           in: query
           required: false
           description: |
-            Whether to include hidden indexes in the result.
+            Whether to include hidden indexes in the result. Internal indexes
+            and ones that are currently built in the background are hidden.
           schema:
             type: boolean
       responses:
diff --git a/site/content/3.10/index-and-search/indexing/working-with-indexes/_index.md b/site/content/3.10/index-and-search/indexing/working-with-indexes/_index.md
@@ -62,7 +62,8 @@ You can set the following parameters:
 - `withStats` (boolean, _optional_): whether to include index figures and
   estimates in the result. Default: `false`
 - `withHidden` (boolean, _optional_): whether to include hidden indexes in the
-  result. Default: `false`
+  result. Internal indexes and ones that are currently built in the background
+  are hidden. Default: `false`
 
 The `indexes()` method is an alias for `getIndexes()`.
 
diff --git a/site/content/3.10/release-notes/version-3.10/known-issues-in-3-10.md b/site/content/3.10/release-notes/version-3.10/known-issues-in-3-10.md
@@ -68,3 +68,4 @@ Note that this page does not list all open issues.
 | **Date Added:** 2023-02-17 <br> **Component:** ArangoDB Starter <br> **Deployment Mode:** All <br> **Description:** When using a Windows build with `netgo`, the `localhost` cannot be resolved. <br> **Affected Versions:** 3.9.8, 3.10.3 <br> **Fixed in Versions:** 3.9.9, 3.10.4 <br> **Reference:** [GT-330](https://arangodb.atlassian.net/browse/GT-330) (internal) |
 | **Date Added:** 2023-06-07 <br> **Component:** ArangoSync <br> **Deployment Mode:** All <br> **Description:** In ArangoSync v2.18.0, synchronization may be interrupted with errors like "CloneDirectMQToken failed" due to network disturbances. <br> **Affected Versions:** 3.9.11, 3.10.7 <br> **Fixed in Versions:** - <br> **Reference:** N/A |
 | **Date Added:** 2023-06-16 <br> **Component:** arangod <br> **Deployment Mode:** Cluster <br> **Description:** If more than a certain threshold of queries on the same Coordinator get into the shutdown networking code at the same time, all of them lock up and the Coordinator does not longer process requests. <br> **Affected Versions:** 3.9.x. 3.10.x <br> **Fixed in Versions:** 3.9.12, 3.10.8 <br> **Reference:** [BTS-1486](https://arangodb.atlassian.net/browse/BTS-1486) (internal) |
+| **Date Added:** 2024-03-21 <br> **Component:** arangod <br> **Deployment Mode:** All <br> **Description:** When creating an `inverted` index with the `inBackground` option enabled, HTTP API calls like `http://localhost:8529/_api/index?collection=<coll>&withHidden=true` don't return the `isBuilding` and `progress` attributes and the progress of the index building can thus not be observed. <br> **Affected Versions:** 3.10.13 <br> **Fixed in Versions:** - <br> **Reference:** [BTS-1788](https://arangodb.atlassian.net/browse/BTS-1788) (internal) |
diff --git a/site/content/3.11/develop/http-api/indexes/_index.md b/site/content/3.11/develop/http-api/indexes/_index.md
@@ -54,7 +54,8 @@ paths:
           in: query
           required: false
           description: |
-            Whether to include hidden indexes in the result.
+            Whether to include hidden indexes in the result. Internal indexes
+            and ones that are currently built in the background are hidden.
           schema:
             type: boolean
       responses:
diff --git a/site/content/3.11/index-and-search/indexing/working-with-indexes/_index.md b/site/content/3.11/index-and-search/indexing/working-with-indexes/_index.md
@@ -62,7 +62,8 @@ You can set the following parameters:
 - `withStats` (boolean, _optional_): whether to include index figures and
   estimates in the result. Default: `false`
 - `withHidden` (boolean, _optional_): whether to include hidden indexes in the
-  result. Default: `false`
+  result. Internal indexes and ones that are currently built in the background
+  are hidden. Default: `false`
 
 The `indexes()` method is an alias for `getIndexes()`.
 
diff --git a/site/content/3.11/release-notes/version-3.10/known-issues-in-3-10.md b/site/content/3.11/release-notes/version-3.10/known-issues-in-3-10.md
@@ -68,3 +68,4 @@ Note that this page does not list all open issues.
 | **Date Added:** 2023-02-17 <br> **Component:** ArangoDB Starter <br> **Deployment Mode:** All <br> **Description:** When using a Windows build with `netgo`, the `localhost` cannot be resolved. <br> **Affected Versions:** 3.9.8, 3.10.3 <br> **Fixed in Versions:** 3.9.9, 3.10.4 <br> **Reference:** [GT-330](https://arangodb.atlassian.net/browse/GT-330) (internal) |
 | **Date Added:** 2023-06-07 <br> **Component:** ArangoSync <br> **Deployment Mode:** All <br> **Description:** In ArangoSync v2.18.0, synchronization may be interrupted with errors like "CloneDirectMQToken failed" due to network disturbances. <br> **Affected Versions:** 3.9.11, 3.10.7 <br> **Fixed in Versions:** - <br> **Reference:** N/A |
 | **Date Added:** 2023-06-16 <br> **Component:** arangod <br> **Deployment Mode:** Cluster <br> **Description:** If more than a certain threshold of queries on the same Coordinator get into the shutdown networking code at the same time, all of them lock up and the Coordinator does not longer process requests. <br> **Affected Versions:** 3.9.x. 3.10.x <br> **Fixed in Versions:** 3.9.12, 3.10.8 <br> **Reference:** [BTS-1486](https://arangodb.atlassian.net/browse/BTS-1486) (internal) |
+| **Date Added:** 2024-03-21 <br> **Component:** arangod <br> **Deployment Mode:** All <br> **Description:** When creating an `inverted` index with the `inBackground` option enabled, HTTP API calls like `http://localhost:8529/_api/index?collection=<coll>&withHidden=true` don't return the `isBuilding` and `progress` attributes and the progress of the index building can thus not be observed. <br> **Affected Versions:** 3.10.13 <br> **Fixed in Versions:** - <br> **Reference:** [BTS-1788](https://arangodb.atlassian.net/browse/BTS-1788) (internal) |
diff --git a/site/content/3.11/release-notes/version-3.11/known-issues-in-3-11.md b/site/content/3.11/release-notes/version-3.11/known-issues-in-3-11.md
@@ -63,3 +63,4 @@ Note that this page does not list all open issues.
 | **Date Added:** 2023-05-25 <br> **Component:** arangod <br> **Deployment Mode:** All <br> **Description:** When starting an async job by sending a request with the `x-arango-async: store` or `x-arango-async: keep` HTTP header **and** additionally sending the `accept-encoding: gzip` or `accept-encoding: deflate` HTTP header , the generated response may be compressed twice when fetching the async job's response later via the `/_api/job/<id>` REST API. <br> **Affected Versions:** 3.11.0 <br> **Fixed in Versions:** 3.11.1 <br> **Reference:** [arangodb/arangodb#19103](https://github.com/arangodb/arangodb/pull/19103) |
 | **Date Added:** 2023-06-15 <br> **Component:** arangod <br> **Deployment Mode:** Cluster <br> **Description:** After an upgrade to 3.11.0 from an older version of ArangoDB with existing data, the following issue may occur after performing a HotBackup: `_pregel_queries` collections do not exist. <br> **Affected Versions:** 3.11.x <br> **Fixed in Versions:** - <br> **Reference:** [BTS-1462](https://arangodb.atlassian.net/browse/BTS-1462) (internal) |
 | **Date Added:** 2023-06-16 <br> **Component:** arangod <br> **Deployment Mode:** Cluster <br> **Description:** If more than a certain threshold of queries on the same Coordinator get into the shutdown networking code at the same time, all of them lock up and the Coordinator does not longer process requests. <br> **Affected Versions:** 3.9.x. 3.10.x, 3.11.x <br> **Fixed in Versions:** 3.9.12, 3.10.8, 3.11.2 <br> **Reference:** [BTS-1486](https://arangodb.atlassian.net/browse/BTS-1486) (internal) |
+| **Date Added:** 2024-03-21 <br> **Component:** arangod <br> **Deployment Mode:** All <br> **Description:** When creating an `inverted` index with the `inBackground` option enabled, HTTP API calls like `http://localhost:8529/_api/index?collection=<coll>&withHidden=true` don't return the `isBuilding` and `progress` attributes and the progress of the index building can thus not be observed. <br> **Affected Versions:** 3.10.13, 3.11.7 <br> **Fixed in Versions:** - <br> **Reference:** [BTS-1788](https://arangodb.atlassian.net/browse/BTS-1788) (internal) |
diff --git a/site/content/3.12/develop/http-api/indexes/_index.md b/site/content/3.12/develop/http-api/indexes/_index.md
@@ -54,7 +54,8 @@ paths:
           in: query
           required: false
           description: |
-            Whether to include hidden indexes in the result.
+            Whether to include hidden indexes in the result. Internal indexes
+            and ones that are currently built in the background are hidden.
           schema:
             type: boolean
       responses:
diff --git a/site/content/3.12/index-and-search/indexing/working-with-indexes/_index.md b/site/content/3.12/index-and-search/indexing/working-with-indexes/_index.md
@@ -62,7 +62,8 @@ You can set the following parameters:
 - `withStats` (boolean, _optional_): whether to include index figures and
   estimates in the result. Default: `false`
 - `withHidden` (boolean, _optional_): whether to include hidden indexes in the
-  result. Default: `false`
+  result. Internal indexes and ones that are currently built in the background
+  are hidden. Default: `false`
 
 The `indexes()` method is an alias for `getIndexes()`.
 
diff --git a/site/content/3.12/release-notes/version-3.10/known-issues-in-3-10.md b/site/content/3.12/release-notes/version-3.10/known-issues-in-3-10.md
@@ -68,3 +68,4 @@ Note that this page does not list all open issues.
 | **Date Added:** 2023-02-17 <br> **Component:** ArangoDB Starter <br> **Deployment Mode:** All <br> **Description:** When using a Windows build with `netgo`, the `localhost` cannot be resolved. <br> **Affected Versions:** 3.9.8, 3.10.3 <br> **Fixed in Versions:** 3.9.9, 3.10.4 <br> **Reference:** [GT-330](https://arangodb.atlassian.net/browse/GT-330) (internal) |
 | **Date Added:** 2023-06-07 <br> **Component:** ArangoSync <br> **Deployment Mode:** All <br> **Description:** In ArangoSync v2.18.0, synchronization may be interrupted with errors like "CloneDirectMQToken failed" due to network disturbances. <br> **Affected Versions:** 3.9.11, 3.10.7 <br> **Fixed in Versions:** - <br> **Reference:** N/A |
 | **Date Added:** 2023-06-16 <br> **Component:** arangod <br> **Deployment Mode:** Cluster <br> **Description:** If more than a certain threshold of queries on the same Coordinator get into the shutdown networking code at the same time, all of them lock up and the Coordinator does not longer process requests. <br> **Affected Versions:** 3.9.x. 3.10.x <br> **Fixed in Versions:** 3.9.12, 3.10.8 <br> **Reference:** [BTS-1486](https://arangodb.atlassian.net/browse/BTS-1486) (internal) |
+| **Date Added:** 2024-03-21 <br> **Component:** arangod <br> **Deployment Mode:** All <br> **Description:** When creating an `inverted` index with the `inBackground` option enabled, HTTP API calls like `http://localhost:8529/_api/index?collection=<coll>&withHidden=true` don't return the `isBuilding` and `progress` attributes and the progress of the index building can thus not be observed. <br> **Affected Versions:** 3.10.13 <br> **Fixed in Versions:** - <br> **Reference:** [BTS-1788](https://arangodb.atlassian.net/browse/BTS-1788) (internal) |
diff --git a/site/content/3.12/release-notes/version-3.11/known-issues-in-3-11.md b/site/content/3.12/release-notes/version-3.11/known-issues-in-3-11.md
@@ -63,3 +63,4 @@ Note that this page does not list all open issues.
 | **Date Added:** 2023-05-25 <br> **Component:** arangod <br> **Deployment Mode:** All <br> **Description:** When starting an async job by sending a request with the `x-arango-async: store` or `x-arango-async: keep` HTTP header **and** additionally sending the `accept-encoding: gzip` or `accept-encoding: deflate` HTTP header , the generated response may be compressed twice when fetching the async job's response later via the `/_api/job/<id>` REST API. <br> **Affected Versions:** 3.11.0 <br> **Fixed in Versions:** 3.11.1 <br> **Reference:** [arangodb/arangodb#19103](https://github.com/arangodb/arangodb/pull/19103) |
 | **Date Added:** 2023-06-15 <br> **Component:** arangod <br> **Deployment Mode:** Cluster <br> **Description:** After an upgrade to 3.11.0 from an older version of ArangoDB with existing data, the following issue may occur after performing a HotBackup: `_pregel_queries` collections do not exist. <br> **Affected Versions:** 3.11.x <br> **Fixed in Versions:** - <br> **Reference:** [BTS-1462](https://arangodb.atlassian.net/browse/BTS-1462) (internal) |
 | **Date Added:** 2023-06-16 <br> **Component:** arangod <br> **Deployment Mode:** Cluster <br> **Description:** If more than a certain threshold of queries on the same Coordinator get into the shutdown networking code at the same time, all of them lock up and the Coordinator does not longer process requests. <br> **Affected Versions:** 3.9.x. 3.10.x, 3.11.x <br> **Fixed in Versions:** 3.9.12, 3.10.8, 3.11.2 <br> **Reference:** [BTS-1486](https://arangodb.atlassian.net/browse/BTS-1486) (internal) |
+| **Date Added:** 2024-03-21 <br> **Component:** arangod <br> **Deployment Mode:** All <br> **Description:** When creating an `inverted` index with the `inBackground` option enabled, HTTP API calls like `http://localhost:8529/_api/index?collection=<coll>&withHidden=true` don't return the `isBuilding` and `progress` attributes and the progress of the index building can thus not be observed. <br> **Affected Versions:** 3.10.13, 3.11.7 <br> **Fixed in Versions:** - <br> **Reference:** [BTS-1788](https://arangodb.atlassian.net/browse/BTS-1788) (internal) |
diff --git a/site/content/3.12/release-notes/version-3.12/incompatible-changes-in-3-12.md b/site/content/3.12/release-notes/version-3.12/incompatible-changes-in-3-12.md
@@ -170,6 +170,27 @@ onward and will be removed in a future version.
 You can use [Stream Transactions](../../develop/transactions/stream-transactions.md)
 instead in most cases, and in some cases AQL can be sufficient.
 
+## Breaking changes to the `collation` Analyzer
+
+The [`collation` Analyzer](../../index-and-search/analyzers.md#collation) lets
+you adhere to the alphabetic order of a language in range queries. For example,
+using a Swedish locale (`sv`), the sorting order is `å` after `z`, whereas using
+an English locale (`en`), `å` is preceded by `a`. This impacts queries with
+`SEARCH` expressions like `doc.text < "c"`, excluding `å` when using the Swedish
+locale.
+
+ArangoDB 3.12 bundles an upgraded version of the ICU library. It is used for
+Unicode character handling including text sorting. Because of changes in ICU,
+data produced by the `collation` Analyzer in previous versions is not compatible
+with ArangoDB v3.12. You need to **recreate inverted indexes and Views that use
+`collation` Analyzers** to ensure that they work correctly. Otherwise,
+range queries involving the `collation` Analyzers and indexes created in v3.11
+or older versions may behave in unpredicted ways.
+
+Note that sorting by the output of the `collation` Analyzer like
+`SORT TOKENS(<text>, <collationAnalyzer>)` is still not a supported feature and
+doesn't produce meaningful results.
+
 ## Control character escaping in audit log
 
 The audit log feature of the Enterprise Edition previously logged query strings
diff --git a/site/content/3.12/release-notes/version-3.12/known-issues-in-3-12.md b/site/content/3.12/release-notes/version-3.12/known-issues-in-3-12.md
@@ -51,3 +51,4 @@ Note that this page does not list all open issues.
 | **Date Added:** 2019-04-03 <br> **Component:** arangod <br> **Deployment Mode:** Cluster <br> **Description:** Updating the properties of a collection in the cluster may return before the properties are updated consistently on all shards. This is especially visible when setting a schema for a collection with multiple shards, and then instantly starting to store non-conforming documents into the collection. These may be accepted until the properties change has been fully propagated to all shards. <br> **Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x, 3.12.x <br> **Fixed in Versions:** - <br> **Reference:** N/A |
 | **Date Added:** 2021-04-07 <br> **Component:** arangod <br> **Deployment Mode:** All <br> **Description:** The Batch API (HTTP endpoint `/_api/batch`) cannot be used in combination with Stream transactions to submit batched requests, because the required header `x-arango-trx-id` is not forwarded. It only processes `Content-Type` and `Content-Id`. <br> **Affected Versions:** 3.5.x, 3.6.x, 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x, 3.12.x <br> **Fixed in Versions:** - <br> **Reference:** [arangodb/arangodb#13552](https://github.com/arangodb/arangodb/issues/13552) |
 | **Date Added:** 2022-09-29 <br> **Component:** ArangoDB Starter <br> **Deployment Mode:** All <br> **Description:** The ArangoDB Starter may fail to pick a Docker container name from cgroups. <br> **Affected Versions:** 3.8.x, 3.9.x, 3.10.x, 3.11.x, 3.12.x <br> **Fixed in Versions:** - <br> **Reference:** [GT-207](https://arangodb.atlassian.net/browse/GT-207) (internal) |
+| **Date Added:** 2024-03-21 <br> **Component:** arangod <br> **Deployment Mode:** All <br> **Description:** When creating an `inverted` index with the `inBackground` option enabled, HTTP API calls like `http://localhost:8529/_api/index?collection=<coll>&withHidden=true` don't return the `isBuilding` and `progress` attributes and the progress of the index building can thus not be observed. <br> **Affected Versions:** 3.10.13, 3.11.7, 3.12.x <br> **Fixed in Versions:** - <br> **Reference:** [BTS-1788](https://arangodb.atlassian.net/browse/BTS-1788) (internal) |
diff --git a/site/content/3.12/release-notes/version-3.12/whats-new-in-3-12.md b/site/content/3.12/release-notes/version-3.12/whats-new-in-3-12.md
@@ -1205,3 +1205,4 @@ section above that includes a description of the added client tool options.
 For ArangoDB 3.12, the bundled version of rclone is 1.65.2. Check if your
 rclone configuration files require changes.
 
+The bundled version of the OpenSSL library has been upgraded to 3.2.1.
diff --git a/site/content/4.0/develop/http-api/indexes/_index.md b/site/content/4.0/develop/http-api/indexes/_index.md
@@ -54,7 +54,8 @@ paths:
           in: query
           required: false
           description: |
-            Whether to include hidden indexes in the result.
+            Whether to include hidden indexes in the result. Internal indexes
+            and ones that are currently built in the background are hidden.
           schema:
             type: boolean
       responses:
diff --git a/site/content/4.0/index-and-search/indexing/working-with-indexes/_index.md b/site/content/4.0/index-and-search/indexing/working-with-indexes/_index.md
@@ -62,7 +62,8 @@ You can set the following parameters:
 - `withStats` (boolean, _optional_): whether to include index figures and
   estimates in the result. Default: `false`
 - `withHidden` (boolean, _optional_): whether to include hidden indexes in the
-  result. Default: `false`
+  result. Internal indexes and ones that are currently built in the background
+  are hidden. Default: `false`
 
 The `indexes()` method is an alias for `getIndexes()`.
 
diff --git a/site/content/4.0/release-notes/version-3.10/known-issues-in-3-10.md b/site/content/4.0/release-notes/version-3.10/known-issues-in-3-10.md
@@ -68,3 +68,4 @@ Note that this page does not list all open issues.
 | **Date Added:** 2023-02-17 <br> **Component:** ArangoDB Starter <br> **Deployment Mode:** All <br> **Description:** When using a Windows build with `netgo`, the `localhost` cannot be resolved. <br> **Affected Versions:** 3.9.8, 3.10.3 <br> **Fixed in Versions:** 3.9.9, 3.10.4 <br> **Reference:** [GT-330](https://arangodb.atlassian.net/browse/GT-330) (internal) |
 | **Date Added:** 2023-06-07 <br> **Component:** ArangoSync <br> **Deployment Mode:** All <br> **Description:** In ArangoSync v2.18.0, synchronization may be interrupted with errors like "CloneDirectMQToken failed" due to network disturbances. <br> **Affected Versions:** 3.9.11, 3.10.7 <br> **Fixed in Versions:** - <br> **Reference:** N/A |
 | **Date Added:** 2023-06-16 <br> **Component:** arangod <br> **Deployment Mode:** Cluster <br> **Description:** If more than a certain threshold of queries on the same Coordinator get into the shutdown networking code at the same time, all of them lock up and the Coordinator does not longer process requests. <br> **Affected Versions:** 3.9.x. 3.10.x <br> **Fixed in Versions:** 3.9.12, 3.10.8 <br> **Reference:** [BTS-1486](https://arangodb.atlassian.net/browse/BTS-1486) (internal) |
+| **Date Added:** 2024-03-21 <br> **Component:** arangod <br> **Deployment Mode:** All <br> **Description:** When creating an `inverted` index with the `inBackground` option enabled, HTTP API calls like `http://localhost:8529/_api/index?collection=<coll>&withHidden=true` don't return the `isBuilding` and `progress` attributes and the progress of the index building can thus not be observed. <br> **Affected Versions:** 3.10.13 <br> **Fixed in Versions:** - <br> **Reference:** [BTS-1788](https://arangodb.atlassian.net/browse/BTS-1788) (internal) |
diff --git a/site/content/4.0/release-notes/version-3.11/known-issues-in-3-11.md b/site/content/4.0/release-notes/version-3.11/known-issues-in-3-11.md
diff --git a/site/content/4.0/release-notes/version-3.12/incompatible-changes-in-3-12.md b/site/content/4.0/release-notes/version-3.12/incompatible-changes-in-3-12.md
diff --git a/site/content/4.0/release-notes/version-3.12/known-issues-in-3-12.md b/site/content/4.0/release-notes/version-3.12/known-issues-in-3-12.md
diff --git a/site/content/4.0/release-notes/version-3.12/whats-new-in-3-12.md b/site/content/4.0/release-notes/version-3.12/whats-new-in-3-12.md
diff --git a/site/content/4.0/release-notes/version-4.0/known-issues-in-4-0.md b/site/content/4.0/release-notes/version-4.0/known-issues-in-4-0.md
