Package com.arangodb.model.arangosearch
Class ArangoSearchCreateOptions
- java.lang.Object
-
- com.arangodb.model.arangosearch.ArangoSearchCreateOptions
-
public final class ArangoSearchCreateOptions extends Object
- Author:
- Mark Vollmary
-
-
Constructor Summary
Constructors Constructor Description ArangoSearchCreateOptions()
-
Method Summary
-
-
-
Method Detail
-
consolidationIntervalMsec
public ArangoSearchCreateOptions consolidationIntervalMsec(Long consolidationIntervalMsec)
- Parameters:
consolidationIntervalMsec
- 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.- Returns:
- options
-
commitIntervalMsec
public ArangoSearchCreateOptions commitIntervalMsec(Long commitIntervalMsec)
- Parameters:
commitIntervalMsec
- 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.- Returns:
- options
-
cleanupIntervalStep
public ArangoSearchCreateOptions cleanupIntervalStep(Long cleanupIntervalStep)
- Parameters:
cleanupIntervalStep
- 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.- Returns:
- options
-
consolidationPolicy
public ArangoSearchCreateOptions consolidationPolicy(ConsolidationPolicy consolidationPolicy)
- Parameters:
consolidationPolicy
-- Returns:
- options
-
link
public ArangoSearchCreateOptions link(CollectionLink... links)
- Parameters:
links
- A list of linked collections- Returns:
- options
-
primarySort
public ArangoSearchCreateOptions primarySort(PrimarySort... primarySorts)
- Parameters:
primarySorts
- A list of linked collections- Returns:
- options
-
primarySortCompression
public ArangoSearchCreateOptions primarySortCompression(ArangoSearchCompression primarySortCompression)
- Parameters:
primarySortCompression
- Defines how to compress the primary sort data- Returns:
- options
-
storedValues
public ArangoSearchCreateOptions storedValues(StoredValue... storedValues)
- Returns:
- options
-
getName
public String getName()
-
getType
public ViewType getType()
-
getConsolidationIntervalMsec
public Long getConsolidationIntervalMsec()
-
getCommitIntervalMsec
public Long getCommitIntervalMsec()
-
getCleanupIntervalStep
public Long getCleanupIntervalStep()
-
getConsolidationPolicy
public ConsolidationPolicy getConsolidationPolicy()
-
getLinks
public Collection<CollectionLink> getLinks()
-
getPrimarySorts
public Collection<PrimarySort> getPrimarySorts()
-
getPrimarySortCompression
public ArangoSearchCompression getPrimarySortCompression()
-
getStoredValues
public Collection<StoredValue> getStoredValues()
-
-