Skip to content

New consolidation default values for inverted indexes and arangosearch Views in 3.12.6 #839

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 24, 2025
Merged

New consolidation default values for inverted indexes and arangosearch Views in 3.12.6 #839

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions site/content/arangodb/3.12/develop/http-api/indexes/inverted.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -537,7 +537,7 @@ paths:
compaction operations are governed by `consolidationIntervalMsec` and the
candidates for compaction are selected via `consolidationPolicy`.
type: integer
default: 1000
default: 5000
consolidationPolicy:
description: |
The consolidation policy to apply for selecting which segments should be merged.
Expand Down Expand Up @@ -570,24 +570,24 @@ paths:
Defines the value (in bytes) to treat all smaller segments as equal for
consolidation selection.
type: integer
default: 2097152
default: 25165824
segmentsBytesMax:
description: |
The maximum allowed size of all consolidated segments in bytes.
type: integer
default: 5368709120
default: 8589934592
segmentsMax:
description: |
The maximum number of segments that are evaluated as candidates for
consolidation.
type: integer
default: 10
default: 200
segmentsMin:
description: |
The minimum number of segments that are evaluated as candidates for
consolidation.
type: integer
default: 1
default: 50
minScore:
description: |
Filter out consolidation candidates with a score less than this.
Expand Down
28 changes: 14 additions & 14 deletions site/content/arangodb/3.12/develop/http-api/views/arangosearch-views.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ paths:
compaction operations are governed by `consolidationIntervalMsec` and the
candidates for compaction are selected via `consolidationPolicy`.
type: integer
default: 10000
default: 5000
consolidationPolicy:
description: |
The consolidation policy to apply for selecting which segments should be merged.
Expand Down Expand Up @@ -351,24 +351,24 @@ paths:
Defines the value (in bytes) to treat all smaller segments
as equal for consolidation selection.
type: integer
default: 2097152
default: 25165824
segmentsBytesMax:
description: |
Maximum allowed size of all consolidated segments in bytes.
type: integer
default: 5368709120
default: 8589934592
segmentsMax:
description: |
The maximum number of segments that are evaluated as
candidates for consolidation.
type: integer
default: 10
default: 200
segmentsMin:
description: |
The minimum number of segments that are
evaluated as candidates for consolidation
type: integer
default: 1
default: 50
minScore:
description: |
Filter out consolidation candidates with a score less than this.
Expand Down Expand Up @@ -1398,7 +1398,7 @@ paths:
compaction operations are governed by `consolidationIntervalMsec` and the
candidates for compaction are selected via `consolidationPolicy`.
type: integer
default: 10000
default: 5000
consolidationPolicy:
description: |
The consolidation policy to apply for selecting which segments should be merged.
Expand Down Expand Up @@ -1447,24 +1447,24 @@ paths:
Defines the value (in bytes) to treat all smaller segments
as equal for consolidation selection.
type: integer
default: 2097152
default: 25165824
segmentsBytesMax:
description: |
Maximum allowed size of all consolidated segments in bytes.
type: integer
default: 5368709120
default: 8589934592
segmentsMax:
description: |
The maximum number of segments that are evaluated as
candidates for consolidation.
type: integer
default: 10
default: 200
segmentsMin:
description: |
The minimum number of segments that are
evaluated as candidates for consolidation
type: integer
default: 1
default: 50
minScore:
description: |
Filter out consolidation candidates with a score less than this.
Expand Down Expand Up @@ -1955,24 +1955,24 @@ paths:
Defines the value (in bytes) to treat all smaller segments
as equal for consolidation selection.
type: integer
default: 2097152
default: 25165824
segmentsBytesMax:
description: |
Maximum allowed size of all consolidated segments in bytes.
type: integer
default: 5368709120
default: 8589934592
segmentsMax:
description: |
The maximum number of segments that are evaluated as
candidates for consolidation.
type: integer
default: 10
default: 200
segmentsMin:
description: |
The minimum number of segments that are
evaluated as candidates for consolidation
type: integer
default: 1
default: 50
minScore:
description: |
Filter out consolidation candidates with a score less than this.
Expand Down
10 changes: 5 additions & 5 deletions ...t/arangodb/3.12/indexes-and-search/arangosearch/arangosearch-views-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,7 +398,7 @@ of removing unused segments after release of internal resources.
> subsequent ArangoDB transactions. In-progress ArangoDB transactions
> still continue to return a repeatable-read state.

- **consolidationIntervalMsec** (_optional_; type: `integer`; default: `1000`;
- **consolidationIntervalMsec** (_optional_; type: `integer`; default: `5000`;
to disable use: `0`)

Wait at least this many milliseconds between applying `consolidationPolicy` to
Expand Down Expand Up @@ -483,19 +483,19 @@ is used by these writers (in terms of "writers pool") one can use

`consolidationPolicy` properties for `"tier"` type:

- **segmentsMin** (_optional_; type: `integer`; default: `1`)
- **segmentsMin** (_optional_; type: `integer`; default: `50`)

The minimum number of segments that are evaluated as candidates for consolidation.

- **segmentsMax** (_optional_; type: `integer`; default: `10`)
- **segmentsMax** (_optional_; type: `integer`; default: `200`)

The maximum number of segments that are evaluated as candidates for consolidation.

- **segmentsBytesMax** (_optional_; type: `integer`; default: `5368709120`)
- **segmentsBytesMax** (_optional_; type: `integer`; default: `8589934592`)

Maximum allowed size of all consolidated segments in bytes.

- **segmentsBytesFloor** (_optional_; type: `integer`; default: `2097152`)
- **segmentsBytesFloor** (_optional_; type: `integer`; default: `25165824`)

Defines the value (in bytes) to treat all smaller segments as equal for consolidation
selection.
Expand Down
32 changes: 31 additions & 1 deletion site/content/arangodb/3.12/release-notes/version-3.12/api-changes-in-3-12.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,13 +340,29 @@ for related API changes.

#### View API

##### `optimizeTopK` property for `arangosearch` Views

Views of type `arangosearch` accept a new `optimizeTopK` View property for the
ArangoSearch WAND optimization. It is an immutable array of strings, optional,
and defaults to `[]`.

See the [`optimizeTopK` View property](../../indexes-and-search/arangosearch/arangosearch-views-reference.md#view-properties)
for details.

##### Changed consolidation defaults for `arangosearch` Views

<small>Introduced in: v3.12.6</small>

The default values for consolidating `arangosearch` Views have been changed.
By consolidating less often and with more data, less file descriptors are used.

- `consolidationIntervalMsec` increased from `1000` to `5000`
- `consolidationPolicy` (with `type` set to `tier`):
- `segmentsMin` increased from `1` to `50`
- `segmentsMax` increased from `10` to `200`
- `segmentsBytesMax` increased from `5368709120` (5 GiB) to `8589934592` (8 GiB)
- `segmentsBytesFloor` increased from `2097152` (2 MiB) to `25165824` (24 MiB)

#### Document API

The following endpoints accept a new `versionAttribute` query parameter that adds
Expand Down Expand Up @@ -463,14 +479,28 @@ add the `withHidden=true` query parameter to the call of the endpoint.
curl "http://localhost:8529/_api/index?collection=myCollection&withHidden=true"
```

#### Vector indexes
##### Vector indexes

<small>Introduced in: v3.12.4</small>

A new `vector` index type has been added.
See [HTTP interface for vector indexes](../../develop/http-api/indexes/vector.md)
for details.

##### Changed consolidation defaults for inverted indexes

<small>Introduced in: v3.12.6</small>

The default values for consolidating inverted indexes have been changed.
By consolidating less often and with more data, less file descriptors are used.

- `consolidationIntervalMsec` increased from `1000` to `5000`
- `consolidationPolicy` (with `type` set to `tier`):
- `segmentsMin` increased from `1` to `50`
- `segmentsMax` increased from `10` to `200`
- `segmentsBytesMax` increased from `5368709120` (5 GiB) to `8589934592` (8 GiB)
- `segmentsBytesFloor` increased from `2097152` (2 MiB) to `25165824` (24 MiB)

#### Optimizer rule descriptions

<small>Introduced in: v3.10.9, v3.11.2</small>
Expand Down
15 changes: 15 additions & 0 deletions ...ontent/arangodb/3.12/release-notes/version-3.12/incompatible-changes-in-3-12.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -979,6 +979,21 @@ header or an invalid URL, it now sends a response with an error object instead
of closing the connection, e.g. that the URL is corrupt with an HTTP status code
of 400.

## Changed consolidation defaults for inverted indexes and `arangosearch` Views

<small>Introduced in: v3.12.6</small>

The default values for consolidating inverted indexes as well as
`arangosearch` Views have been changed. By consolidating less often and with
more data, less file descriptors are used.

- `consolidationIntervalMsec` increased from `1000` to `5000`
- `consolidationPolicy` (with `type` set to `tier`):
- `segmentsMin` increased from `1` to `50`
- `segmentsMax` increased from `10` to `200`
- `segmentsBytesMax` increased from `5368709120` (5 GiB) to `8589934592` (8 GiB)
- `segmentsBytesFloor` increased from `2097152` (2 MiB) to `25165824` (24 MiB)

## HTTP RESTful API

### JavaScript-based traversal using `/_api/traversal` removed
Expand Down
10 changes: 5 additions & 5 deletions site/content/arangodb/4.0/develop/http-api/indexes/inverted.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -537,7 +537,7 @@ paths:
compaction operations are governed by `consolidationIntervalMsec` and the
candidates for compaction are selected via `consolidationPolicy`.
type: integer
default: 1000
default: 5000
consolidationPolicy:
description: |
The consolidation policy to apply for selecting which segments should be merged.
Expand Down Expand Up @@ -570,24 +570,24 @@ paths:
Defines the value (in bytes) to treat all smaller segments as equal for
consolidation selection.
type: integer
default: 2097152
default: 25165824
segmentsBytesMax:
description: |
The maximum allowed size of all consolidated segments in bytes.
type: integer
default: 5368709120
default: 8589934592
segmentsMax:
description: |
The maximum number of segments that are evaluated as candidates for
consolidation.
type: integer
default: 10
default: 200
segmentsMin:
description: |
The minimum number of segments that are evaluated as candidates for
consolidation.
type: integer
default: 1
default: 50
minScore:
description: |
Filter out consolidation candidates with a score less than this.
Expand Down
Loading