A link definition for an ArangoSearch View.
A list of names of Analyzers to apply to values of processed document attributes.
Default: ["identity"]
An object mapping names of attributes to process for each document to ArangoSearchViewLink definitions.
If set to true, all document attributes will be processed, otherwise
only the attributes in fields will be processed.
Default: false
Controls how the view should keep track of the attribute values.
Default: "none"
If set to true, the position of values in array values will be tracked,
otherwise all values in an array will be treated as equal alternatives.
Properties of an ArangoSearch View.
How many commits to wait between removing unused files.
How long to wait between applying the consolidationPolicy.
Consolidation policy to apply for selecting which segments should be merged.
An object mapping names of linked collections to ArangoSearchViewLink definitions.
Attribute path (field) for the value of each document that is
used for sorting.
Compression to use for the primary sort data.
Default: "lz4"
Attribute paths for which values should be stored in the view index
in addition to those used for sorting via primarySort.
Maximum number of concurrent active writers that perform a transaction.
Maximum number of writers cached in the pool.
Maximum memory byte size per writer before a writer flush is triggered.
Properties of an ArangoSearch View.
How many commits to wait between removing unused files.
Default: 2
How long to wait between commiting View data store changes and making documents visible to queries.
Default: 1000
How long to wait between applying the consolidationPolicy.
Default: 10000
Consolidation policy to apply for selecting which segments should be merged.
An object mapping names of linked collections to ArangoSearchViewLink definitions.
Attribute path (field) for the value of each document that will be
used for sorting.
If direction is set to "asc" or asc is set to true,
the primary sorting order will be ascending.
If direction is set to "desc" or asc is set to false,
the primary sorting order will be descending.
Compression to use for the primary sort data.
Default: "lz4"
Attribute paths for which values should be stored in the view index
in addition to those used for sorting via primarySort.
Maximum number of concurrent active writers that perform a transaction.
Default: 0
Maximum number of writers cached in the pool.
Default: 64
Maximum memory byte size per writer before a writer flush is triggered.
Default: 33554432, i.e. 32 MiB
Policy to consolidate based on segment byte size and live document count as dictated by the customization attributes.
Must be in the range of 0.0 to 1.0.
Type of consolidation policy.
Compression to use for primary sort data of a View.
Default: "lz4"
Policy to consolidate if the sum of all candidate segment byte size is less than the total segment byte size multiplied by a given threshold.
Minimum score.
Defines the value to treat all smaller segments as equal for consolidation selection.
Default: 2097152, i.e. 2 MiB
Maximum allowed size of all consolidated segments.
Default: 5368709120, i.e. 5 GiB
Maximum number of segments that will be evaluated as candidates for consolidation.
Default: 10
Minimum number of segments that will be evaluated as candidates for consolidation.
Default: 1
Type of consolidation policy.
Generic description of a View.
A globally unique identifier for this View.
An identifier for this View.
Name of the View.
Type of the View.
Indicates whether the given value represents a View.
A value that might be a View.
Generated using TypeDoc
import type { ArangoSearchView } from "arangojs/view";The "view" module provides View related types and interfaces for TypeScript.