Click or drag to resize

GetViewPropertiesResponse Properties

The GetViewPropertiesResponse type exposes the following members.

Properties
  NameDescription
Public propertyCleanupIntervalStep
The number of commits between removing unused files in the ArangoSearch data directory (default: 2, to disable use: 0). Read more about this in the documentation.
(Inherited from ViewDetails.)
Public propertyCode
The HTTP status code.
Public propertyCommitIntervalMsec
The number of milliseconds to wait between committing View data store changes and making documents visible to queries (default: 1000, to disable use: 0) Read more about this in the documentation.
(Inherited from ViewDetails.)
Public propertyConsolidationIntervalMsec
The number of milliseconds to wait between applying ‘consolidationPolicy’ to consolidate View data store and possibly release space on the filesystem (default: 10000, to disable use: 0). Read more about this in the documentation.
(Inherited from ViewDetails.)
Public propertyConsolidationPolicy
The consolidation policy to apply for selecting which segments should be merged. Read more about this in the documentation.
(Inherited from ViewDetails.)
Public propertyError
Indicates whether an error occurred
Public propertyGloballyUniqueId
The globally unique identifier of the View
(Inherited from ViewResponse.)
Public propertyId
The id of the view
(Inherited from ViewResponse.)
Public propertyLinks
Expects an object with the attribute keys being names of to be linked collections, and the link properties as attribute values.
(Inherited from ViewDetails.)
Public propertyName
The name of the View.
(Inherited from ViewDetails.)
Public propertyPrimarySort
A primary sort order can be defined to enable an AQL optimization. Read more about this in the documentation.
(Inherited from ViewDetails.)
Public propertyPrimarySortCompression
Defines how to compress the primary sort data (introduced in v3.7.1). ArangoDB v3.5 and v3.6 always compress the index using LZ4. This option is immutable. Possible values: 1) LZ4SortCompression (default): use LZ4 fast compression. 2) NoSortCompression: disable compression to trade space for speed. Read more about this in the documentation.
(Inherited from ViewDetails.)
Public propertyStoredValues
An array of objects to describe which document attributes to store in the View index (introduced in v3.7.1). It can then cover search queries, which means the data can be taken from the index directly and accessing the storage engine can be avoided.
(Inherited from ViewDetails.)
Public propertyType
The type of the View. Must be set to ArangoSearchViewType when creating a view. This option is immutable.
(Inherited from ViewDetails.)
Public propertyWritebufferActive
Maximum number of concurrent active writers (segments) that perform a transaction. Other writers (segments) wait till current active writers (segments) finish (default: 0, use 0 to disable, immutable)
(Inherited from ViewDetails.)
Public propertyWritebufferIdle
Maximum number of writers (segments) cached in the pool (default: 64, use 0 to disable, immutable)
(Inherited from ViewDetails.)
Public propertyWritebufferSizeMax
Maximum memory byte size per writer (segment) before a writer (segment) flush is triggered.
(Inherited from ViewDetails.)
Top
See Also