Skip to content

Commit dd81cfa

Browse files
YoguSimran-B
andauthored
Update arangosearch-views-reference.md (#362)
* Update arangosearch-views-reference.md Fix "higher" and "lower" in explanation for commitIntervalMsec A higher value for the interval means the data is commited less frequently, so there will be more time where the index does not account for the changes. Also, memory consumption will grow because the data is not yet flushed to disk yet. * Review * Tweaks --------- Co-authored-by: Simran Spiller <[email protected]>
1 parent 812af60 commit dd81cfa

File tree

12 files changed

+210
-225
lines changed

12 files changed

+210
-225
lines changed

site/content/3.10/develop/foxx-microservices/guides/working-with-files.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,11 @@ the filesystem from within a service:
6161
may therefore cause race conditions and **result in corrupted data**.
6262

6363
- Writing to files outside the service folder introduces external state. In
64-
a cluster this will result in Coordinators no longer being interchangeable.
64+
a cluster, this results in Coordinators no longer being interchangeable.
6565

6666
- Writing to files during setup is unreliable because the setup script may
67-
be executed several times or not at all. In a cluster the setup script
68-
will only be executed on a single Coordinator.
67+
be executed several times or not at all. In a cluster, the setup script
68+
is only executed on a single Coordinator.
6969

7070
Therefore it is almost always a better option to store files using a
7171
specialized, external file storage service
@@ -77,13 +77,13 @@ ArangoDB documents by using a separate collection.
7777
{{< danger >}}
7878
Due to the way ArangoDB stores documents internally, you should not store
7979
file contents alongside other attributes that might be updated independently.
80-
Additionally, large file sizes will impact performance for operations
80+
Additionally, large file sizes impact performance for operations
8181
involving the document and may affect overall database performance.
8282
{{< /danger >}}
8383

8484
{{< warning >}}
8585
In production, you should avoid storing any files in ArangoDB or handling file
86-
uploads in Foxx. The following example will work for moderate amounts of small
86+
uploads in Foxx. The following example works for moderate amounts of small
8787
files but is not recommended for large files or frequent uploads or
8888
modifications.
8989
{{< /warning >}}

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

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -472,10 +472,10 @@ paths:
472472
Wait at least this many commits between removing unused files in the
473473
ArangoSearch data directory (default: 2, to disable use: 0).
474474
For the case where the consolidation policies merge segments often (i.e. a lot
475-
of commit+consolidate), a lower value will cause a lot of disk space to be
475+
of commit+consolidate), a lower value causes a lot of disk space to be
476476
wasted.
477477
For the case where the consolidation policies rarely merge segments (i.e. few
478-
inserts/deletes), a higher value will impact performance without any added
478+
inserts/deletes), a higher value impacts performance without any added
479479
benefits.
480480
481481
_Background:_
@@ -491,12 +491,11 @@ paths:
491491
Wait at least this many milliseconds between committing inverted index data store
492492
changes and making documents visible to queries (default: 1000, to disable
493493
use: 0).
494-
For the case where there are a lot of inserts/updates, a lower value, until
495-
commit, will cause the index not to account for them and memory usage would
496-
continue to grow.
497-
For the case where there are a few inserts/updates, a higher value will impact
498-
performance and waste disk space for each commit call without any added
499-
benefits.
494+
For the case where there are a lot of inserts/updates, a higher value causes the
495+
index not to account for them and memory usage continues to grow until the commit.
496+
A lower value impacts performance, including the case where there are no or only a
497+
few inserts/updates because of synchronous locking, and it wastes disk space for
498+
each commit call.
500499
501500
_Background:_
502501
For data retrieval, ArangoSearch follows the concept of
@@ -518,7 +517,7 @@ paths:
518517
For the case where there are a lot of data modification operations, a higher
519518
value could potentially have the data store consume more space and file handles.
520519
For the case where there are a few data modification operations, a lower value
521-
will impact performance due to no segment candidates available for
520+
impacts performance due to no segment candidates being available for
522521
consolidation.
523522
524523
_Background:_
@@ -536,8 +535,8 @@ paths:
536535
_Background:_
537536
With each ArangoDB transaction that inserts documents, one or more
538537
ArangoSearch-internal segments get created.
539-
Similarly, for removed documents the segments that contain such documents
540-
will have these documents marked as 'deleted'.
538+
Similarly, for removed documents, the segments that contain such documents
539+
have these documents marked as 'deleted'.
541540
Over time, this approach causes a lot of small and sparse segments to be
542541
created.
543542
A "consolidation" operation selects one or more segments and copies all of
@@ -594,7 +593,7 @@ paths:
594593
description: |
595594
Maximum memory byte size per writer (segment) before a writer (segment) flush
596595
is triggered. `0` value turns off this limit for any writer (buffer) and data
597-
will be flushed periodically based on the value defined for the flush thread
596+
is flushed periodically based on the value defined for the flush thread
598597
(ArangoDB server startup option). `0` value should be used carefully due to
599598
high potential memory consumption
600599
(default: 33554432, use 0 to disable)

0 commit comments

Comments
 (0)