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

Commit 256d1af

Browse files
nerpaulaSimran-B
andauthored
DOC-363 | New Web UI for ArangoSearch Views (#1321)
* new web ui for views * Compress screenshots * Formatting, another link * Apply suggestions from code review Co-authored-by: Simran <Simran-B@users.noreply.github.com> * review * review --------- Co-authored-by: Simran Spiller <simran@arangodb.com> Co-authored-by: Simran <Simran-B@users.noreply.github.com>
1 parent 1ca7bd3 commit 256d1af

File tree

5 files changed

+86
-0
lines changed

5 files changed

+86
-0
lines changed

3.11/arangosearch-views-search-alias.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,23 @@ You can add or remove inverted indexes from the View definition:
4444
- **operation** (string, _optional_): whether to add or remove the index to
4545
the stored `indexes` property of the View. Possible values: `"add"`, `"del"`.
4646
The default is `"add"`
47+
48+
## Create `search-alias` Views using the web interface
49+
50+
You can create and manage a `search-alias` View through the web interface.
51+
To get started, follow the steps outlined below.
52+
53+
1. In the web interface, go to the left sidebar menu and select
54+
the **VIEWS** entry.
55+
2. To add a new View, click **Add View**.
56+
3. Fill in the required fields:
57+
- For **Name**, enter a name for the View.
58+
- For **Type**, select `search-alias` from the dropdown menu.
59+
4. Select an existing collection from the dropdown menu. You can also add it
60+
later via the Views editor.
61+
5. Select an existing inverted index of the collection that you previously
62+
selected. You can also add it later via the Views editor.
63+
6. To define multiple indexes, click the **Add index** button.
64+
7. Click **Create**.
65+
66+
![Create new search-alias View](images/arangosearch-create-search-alias-view.png)

3.11/arangosearch-views.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -396,3 +396,40 @@ is used by these writers (in terms of "writers pool") one can use
396396
- **minScore** (_optional_; type: `integer`; default: `0`)
397397

398398
Filter out consolidation candidates with a score less than this.
399+
400+
## Create `arangosearch` Views using the web interface
401+
402+
You can create and manage an `arangosearch` View through the Web Interface.
403+
To get started, follow the steps outlined below.
404+
405+
1. In the web interface, go to the left sidebar menu and select
406+
the **VIEWS** entry.
407+
2. To add a new View, click **Add View**.
408+
3. Fill in the required fields:
409+
- For **Name**, enter a name for the View.
410+
- For **Type**, select `arangosearch` from the dropdown menu.
411+
4. To set the **Primary Sort Compression**, select `LZ4` to use a fast compression
412+
or `none` to disable compression and trade space for speed.
413+
5. To set a **Primary Sort** order, define the following options:
414+
- For **Field**, enter an array of attribute values.
415+
- For **Direction**, select **Ascending** or **Descending** to sort the attributes by.
416+
6. To set **Stored Values**, define the following options:
417+
- For **Fields**, enter an array of objects to define which document attributes
418+
to store in the View index.
419+
- The **Compression** attribute defines the compression type used for the internal
420+
column-store. Select `LZ4` for fast compression or `none` for no compression.
421+
7. In the **Advanced** section, you can define the **Write Buffer** properties of a
422+
View. ArangoSearch uses multiple writer objects that are mapped to processed
423+
segments for carrying out operations on its index. You can control the memory
424+
consumed by these writers by utilizing the following properties:
425+
- For **Write Buffer Idle**, enter a value for the maximum number of writers
426+
(segments) cached in the pool. To disable, use `0`.
427+
- For **Write Buffer Active**, enter a value for the maximum number of
428+
concurrent active writers (segments) that perform a transaction. To disable,
429+
use `0`.
430+
- For **Write Buffer Size Max**, enter a value for the maximum memory byte size
431+
per writer (segment) before a writer (segment) flush is triggered. Use `0` to
432+
turn off this limit for any writer.
433+
8. Click **Create**.
434+
435+
![Create new arangosearch View](images/arangosearch-create-new-view.png)
35.7 KB
Loading
12.8 KB
Loading

3.11/release-notes-new-features311.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,35 @@ This feature is only available in the Enterprise Edition.
2929

3030
See [Analyzers](analyzers.html#geo_s2) for details.
3131

32+
## Web interface
33+
34+
### `search-alias` Views
35+
36+
The 3.11 release of ArangoDB introduces a new web interface for Views that lets
37+
you to create and manage [`search-alias` Views](arangosearch-views-search-alias.html).
38+
39+
Through this dialog, you can easily create a new View and add to it one or more
40+
inverted indexes from your collections that you could otherwise do via the HTTP
41+
or JavaScript API.
42+
43+
When opening your newly created View, you can copy mutable properties from
44+
previously created `search-alias` Views, providing a convenient way to apply
45+
the same settings to multiple Views. In addition, the JSON editor offers the
46+
option to directly write the definition of your View in JSON format.
47+
48+
For more information, see the
49+
[detailed guide](arangosearch-views-search-alias.html#create-search-alias-views-using-the-web-interface).
50+
51+
### `arangosearch` Views
52+
53+
The existing way of creating and managing `arangosearch` Views through the
54+
web interface has been redesigned, offering a more straightforward approach to add
55+
or modify the definition of your View. The settings, links, and JSON editor have
56+
been merged into a single page, allowing for a much quicker workflow.
57+
58+
For more information, see the
59+
[detailed guide](arangosearch-views.html#create-arangosearch-views-using-the-web-interface).
60+
3261
## AQL
3362

3463
### Added AQL functions

0 commit comments

Comments
 (0)