com.arangodb.entity.arangosearch

Class ArangoSearchPropertiesEntity

java.lang.Object

com.arangodb.entity.ViewEntity

com.arangodb.entity.arangosearch.ArangoSearchPropertiesEntity

All Implemented Interfaces:

Entity

public class ArangoSearchPropertiesEntity
extends ViewEntity

Author:

Mark Vollmary, Michele Rastelli

See Also:

API Documentation

Constructor Summary

Constructors

Constructor and Description
ArangoSearchPropertiesEntity(String id, String name, ViewType type, ArangoSearchProperties properties)

Method Summary

Modifier and Type	Method and Description
Long	getCleanupIntervalStep()
Long	getCommitIntervalMsec()
Long	getConsolidationIntervalMsec()
ConsolidationPolicy	getConsolidationPolicy()
Collection<CollectionLink>	getLinks()
Collection<PrimarySort>	getPrimarySort()
ArangoSearchCompression	getPrimarySortCompression()
Collection<StoredValue>	getStoredValues()

Methods inherited from class com.arangodb.entity.ViewEntity

getId, getName, getType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ArangoSearchPropertiesEntity

public ArangoSearchPropertiesEntity(String id,
                                    String name,
                                    ViewType type,
                                    ArangoSearchProperties properties)

Method Detail

getConsolidationIntervalMsec

public Long getConsolidationIntervalMsec()

Returns:

Wait at least this many milliseconds between committing index data changes and making them visible to queries (default: 60000, to disable use: 0). For the case where there are a lot of inserts/updates, a lower value, until commit, will cause the index not to account for them and memory usage would continue to grow. For the case where there are a few inserts/updates, a higher value will impact performance and waste disk space for each commit call without any added benefits.

getCommitIntervalMsec

public Long getCommitIntervalMsec()

Returns:

Wait at least this many milliseconds between committing view data store changes and making documents visible to queries (default: 1000, to disable use: 0). For the case where there are a lot of inserts/updates, a lower value, until commit, will cause the index not to account for them and memory usage would continue to grow. For the case where there are a few inserts/updates, a higher value will impact performance and waste disk space for each commit call without any added benefits. Background: For data retrieval ArangoSearch views follow the concept of “eventually-consistent”, i.e. eventually all the data in ArangoDB will be matched by corresponding query expressions. The concept of ArangoSearch view “commit” operation is introduced to control the upper-bound on the time until document addition/removals are actually reflected by corresponding query expressions. Once a “commit” operation is complete all documents added/removed prior to the start of the “commit” operation will be reflected by queries invoked in subsequent ArangoDB transactions, in-progress ArangoDB transactions will still continue to return a repeatable-read state.

getCleanupIntervalStep

public Long getCleanupIntervalStep()

Returns:

Wait at least this many commits between removing unused files in data directory (default: 10, to disable use: 0). For the case where the consolidation policies merge segments often (i.e. a lot of commit+consolidate), a lower value will cause a lot of disk space to be wasted. For the case where the consolidation policies rarely merge segments (i.e. few inserts/deletes), a higher value will impact performance without any added benefits.

getConsolidationPolicy

public ConsolidationPolicy getConsolidationPolicy()

getLinks

public Collection<CollectionLink> getLinks()

Returns:

A list of linked collections

getPrimarySort

public Collection<PrimarySort> getPrimarySort()

Returns:

A list of primary sort objects

getPrimarySortCompression

public ArangoSearchCompression getPrimarySortCompression()

Returns:

Defines how to compress the primary sort data (introduced in v3.7.0). ArangoDB v3.5 and v3.6 always compress the index using LZ4.

Since:

ArangoDB 3.7

getStoredValues

public Collection<StoredValue> getStoredValues()

Returns:

An array of objects to describe which document attributes to store in the View index. 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.

Since:

ArangoDB 3.7