Skip to content
This repository was archived by the owner on Dec 13, 2023. It is now read-only.

Commit 136aa7e

Browse files
Andrei LobovSimran-B
andauthored
Partially revert #1175 because primarySortCache will be released in v3.9.6 (#1190)
* wip * review comments * Add API changes * Set title for Views reference to avoid literal <code> in page title Co-authored-by: Simran Spiller <simran@arangodb.com> Co-authored-by: Simran <Simran-B@users.noreply.github.com>
1 parent a6ffd77 commit 136aa7e

8 files changed

+23
-53
lines changed

3.10/arangosearch-views-search-alias.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
layout: default
3+
title: search-alias Views Reference
34
---
45
# `search-alias` Views Reference
56

3.10/arangosearch-views.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
layout: default
3+
title: arangosearch Views Reference
34
---
45
`arangosearch` Views Reference
56
==============================

3.11/arangosearch-views-search-alias.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
layout: default
3+
title: search-alias Views Reference
34
---
45
# `search-alias` Views Reference
56

3.11/arangosearch-views.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
layout: default
3+
title: arangosearch Views Reference
34
---
45
`arangosearch` Views Reference
56
==============================

3.9/arangosearch-performance.md

Lines changed: 0 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -120,41 +120,6 @@ The View needs to be created via the HTTP or JavaScript API (arangosh) to set it
120120
The primary sort data is LZ4 compressed by default (`primarySortCompression` is
121121
`"lz4"`). Set it to `"none"` on View creation to trade space for speed.
122122

123-
You can additionally set the `primarySortCache` option to `true` to always cache
124-
the primary sort columns in memory, which can improve the query performance:
125-
126-
```json
127-
{
128-
"links": {
129-
"coll1": {
130-
"fields": {
131-
"text": {},
132-
"date": {}
133-
}
134-
},
135-
"coll2": {
136-
"fields": {
137-
"text": {}
138-
}
139-
},
140-
"primarySort": [
141-
{
142-
"field": "date",
143-
"direction": "desc"
144-
},
145-
{
146-
"field": "text",
147-
"direction": "asc"
148-
}
149-
],
150-
"primarySortCache": true
151-
}
152-
}
153-
```
154-
155-
See the [`primarySortCache` View property](arangosearch-views.html#view-properties)
156-
for details.
157-
158123
## Stored Values
159124

160125
It is possible to directly store the values of document attributes in View

3.9/arangosearch-views.md

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -143,21 +143,6 @@ During view modification the following directives apply:
143143

144144
- `"lz4"` (default): use LZ4 fast compression.
145145
- `"none"`: disable compression to trade space for speed.
146-
147-
- **primarySortCache** (_optional_; type: `boolean`; default: `false`)
148-
149-
<small>Introduced in: v3.9.5</small>
150-
151-
If you enable this option, then the primary sort columns are always cached in
152-
memory. This can improve the performance of queries that utilize the
153-
[primary sort order](arangosearch-performance.html#primary-sort-order).
154-
Otherwise, these values are memory-mapped and it is up to the operating system
155-
to load them from disk into memory and to evict them from memory.
156-
157-
See the [`--arangosearch.columns-cache-limit` startup option](programs-arangod-arangosearch.html)
158-
to control the memory consumption of this cache.
159-
160-
{% include hint-ee.md feature="ArangoSearch caching" %}
161146

162147
- **storedValues** (_optional_; type: `array`; default: `[]`; _immutable_)
163148

3.9/release-notes-api-changes39.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -246,6 +246,25 @@ The `text` and `norm` Analyzers support `language[_COUNTRY]`, the `stem`
246246
Analyzer only `language`. The former syntax is still supported but automatically
247247
normalized to the new syntax.
248248

249+
#### Views API
250+
251+
Views of the type `arangosearch` support new caching options in the
252+
Enterprise Edition.
253+
254+
<small>Introduced in: v3.9.5</small>
255+
256+
- A `cache` option for individual View links or fields (boolean, default: `false`).
257+
- A `cache` option in the definition of a `storedValues` View property
258+
(boolean, immutable, default: `false`).
259+
260+
The `POST /_api/view` endpoint accepts these new options for `arangosearch`
261+
Views, the `GET /_api/view/<view-name>/properties` endpoint may return these
262+
options, and you can change them with the `PUT /_api/view/<view-name>/properties`
263+
and `PATCH /_api/view/<view-name>/properties` endpoints (except the immutable one).
264+
265+
See the [`arangosearch` Views Reference](arangosearch-views.html#link-properties)
266+
for details.
267+
249268
#### Metrics API
250269

251270
<small>Introduced in: v3.9.5</small>

3.9/release-notes-new-features39.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,6 @@ Views of the type `arangosearch` support three new options:
8787
- You can enable the new `cache` option for individual View links or fields
8888
to always cache field normalization values in memory. This can improve the
8989
performance of scoring and ranking queries.
90-
- You can enable the new `primarySortCache` View property to always cache the
91-
primary sort columns in memory. This can improve the performance of queries
92-
that utilize the primary sort order.
9390
- You can enable the new `cache` option in the definition of a `storedValues`
9491
View property to always cache stored values in memory. This can improve the
9592
query performance if stored values are involved.

0 commit comments

Comments
 (0)