Skip to content

Commit 18bdbc4

Browse files
hkernbachrashtao
authored andcommitted
docu for new properties ires (#299)
1 parent fbb77c2 commit 18bdbc4

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

docs/Drivers/Java/Reference/View/ArangoSearch.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,24 @@ view information from the server.
1818

1919
- **options**: `ArangoSearchCreateOptions`
2020

21+
- **commitIntervalMsec**: `Long`
22+
23+
Wait at least this many milliseconds between committing view data store changes
24+
and making documents visible to queries (default: 1000, to disable use: 0). For
25+
the case where there are a lot of inserts/updates, a lower value, until commit,
26+
will cause the index not to account for them and memory usage would continue to
27+
grow. For the case where there are a few inserts/updates, a higher value will
28+
impact performance and waste disk space for each commit call without any added
29+
benefits. Background: For data retrieval ArangoSearch views follow the concept
30+
of "eventually-consistent", i.e. eventually all the data in ArangoDB will be
31+
matched by corresponding query expressions. The concept of ArangoSearch view
32+
"commit" operation is introduced to control the upper-bound on the time until
33+
document addition/removals are actually reflected by corresponding query
34+
expressions. Once a "commit" operation is complete all documents added/removed
35+
prior to the start of the "commit" operation will be reflected by queries
36+
invoked in subsequent ArangoDB transactions, in-progress ArangoDB transactions
37+
will still continue to return a repeatable-read state.
38+
2139
- **consolidationIntervalMsec**: `Long`
2240

2341
Wait at least this many milliseconds between committing index data changes
@@ -54,10 +72,15 @@ view information from the server.
5472
Apply the "consolidation" operation if and only if (default: 300):
5573
`{segmentThreshold} < number_of_segments`
5674

57-
- **link**: `CollectionLink[]`
75+
- **links**: `CollectionLink[]`
5876

5977
A list of linked collections
6078

79+
- **primarySorts**: `CollectionLink[]`
80+
81+
A list of primary sort objects. When creating an ArangoSearch View, you
82+
can optionally define a default sort order.
83+
6184
**Examples**
6285

6386
```Java

0 commit comments

Comments
 (0)