Click or drag to resize

ViewDetails Class

Detailed properties of a view
Inheritance Hierarchy

Namespace:  ArangoDBNetStandard.ViewApi.Models
Assembly:  ArangoDBNetStandard (in ArangoDBNetStandard.dll) Version: 1.1.0
Syntax
public class ViewDetails

The ViewDetails type exposes the following members.

Constructors
  NameDescription
Public methodViewDetails
Initializes a new instance of the ViewDetails class
Top
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.
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.
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.
Public propertyConsolidationPolicy
The consolidation policy to apply for selecting which segments should be merged. Read more about this in the documentation.
Public propertyLinks
Expects an object with the attribute keys being names of to be linked collections, and the link properties as attribute values.
Public propertyName
The name of the View.
Public propertyPrimarySort
A primary sort order can be defined to enable an AQL optimization. Read more about this in the documentation.
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.
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.
Public propertyType
The type of the View. Must be set to ArangoSearchViewType when creating a view. This option is immutable.
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)
Public propertyWritebufferIdle
Maximum number of writers (segments) cached in the pool (default: 64, use 0 to disable, immutable)
Public propertyWritebufferSizeMax
Maximum memory byte size per writer (segment) before a writer (segment) flush is triggered.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields
  NameDescription
Public fieldStatic memberArangoSearchViewType
Possible value for Type
Public fieldStatic memberLZ4SortCompression
Possible value for PrimarySortCompression
Public fieldStatic memberNoSortCompression
Possible value for PrimarySortCompression
Top
See Also