Click or drag to resize

LinkProperties Class

Properties for linked attribute value Links
Inheritance Hierarchy
SystemObject
  ArangoDBNetStandard.ViewApi.ModelsLinkProperties

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

The LinkProperties type exposes the following members.

Constructors
  NameDescription
Public methodLinkProperties
Initializes a new instance of the LinkProperties class
Top
Properties
  NameDescription
Public propertyAnalyzers
A list of analyzers, by name as defined via the Analyzers feature, that should be applied to values of processed document attributes.
Public propertyFields
Fields that should be processed at each level of the document. Each key specifies the document attribute/field to be processed. Note that the value of includeAllFields is also consulted when selecting fields to be processed. Each value specifies the Link properties directives to be used when processing the specified field, an empty/null value denotes inheritance of all (except fields) directives from the current level.
Public propertyInBackground
If set to true, then no exclusive lock is used on the source collection during View index creation, so that it remains basically available. This option can be set when adding links. It does not get persisted as it is not a View property, but only a one-off option.
Public propertyIncludeAllFields
If set to true, then process all document attributes. Otherwise, only consider attributes mentioned in fields. Attributes not explicitly specified in fields will be processed with default link properties, i.e. null. Using includeAllFields for a lot of attributes in combination with complex Analyzers may significantly slow down the indexing process.
Public propertyStoreValues
Controls how the view should keep track of the attribute values. Valid values are NoStoreValue and NoStoreValue. Not to be confused with StoredValues, which stores attribute values in the View index.
Public propertyTrackListPositions
If set to true, then for array values track the value position in arrays. E.g., when querying for the input { attr: [ "valueX", "valueY", "valueZ" ] }, the user must specify: doc.attr[1] == "valueY". Otherwise, all values in an array are treated as equal alternatives. E.g., when querying for the input { attr: [ "valueX", "valueY", "valueZ" ] }, the user must specify: doc.attr == "valueY"
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 memberIdStoreValue
Possible value for StoreValues Do not store value meta data in the View.
Public fieldStatic memberNoStoreValue
Possible value for StoreValues Store information about value presence to allow use of the EXISTS() function.
Top
See Also