Defining ArangoDB Indexes

The following properties are applicable to an ArangoDB Index object.

Tab

Property

Description

Additional Information
  Physical Name Specifies the physical name of the index

 
  Index Type Specifies the index type

Geo: Indicates that the index is a geo index. A geo index is used to locate a place geographically on earth.

Persistent: Indicates that the index is a persistent index. A persistent index is sorted with persistence.

Fulltext: Indicates that the index is a fulltext index. A full text index is used to find prefixes of words or words in a document.

TTL: Indicates that the index is a TTL index. A TTL index is used for removing expired documents automatically.

  Physical Only Specifies whether the index is available in the physical model only  
  Generate Specifies whether the index is generated  
General Index Members Specifies a list of available fields  
Selected Index Members Specifies a list of fields that are included in the index  
Options Unique Specifies whether the index is declared unique This option is supported for persistent, TTL, hash, and skiplist indexes.
Sparse Specifies whether the index is sparse This option is supported for hash, skiplist, and persistent indexes.
Deduplicate Specifies whether the deduplicate attribute of the index is set true Selecting the Deduplicate checkbox ensures that a single instance of each non-unique index is inserted into the index per document. This option is supported for array indexes of type, persistent, hash, and skiplist.
Background Specifies that the index is created in background Creating an index in background ensures the availability of the collection while index is being created. This makes it possible to run CRUD operations on the collections while index is being created.
Min. Length Specifies the minimum length parameter of the index The words shorter than this length are not indexed. This option is supported for fulltext indexes.
Doc Expire After Specifies the time in seconds after which the document expires This option is supported for TTL indexes.
Geo JSON Specifies whether the GeoJSON data-format is used This option is supported for geo indexes.
Estimates Specifies whether index selectivity estimates are maintained for the index This option is supported for persistent indexes.
Comment Update Key Group Definition to Match Specifies whether the key group definition should be updated to match the comment