com.arangodb.model.arangosearch

Class ArangoSearchPropertiesOptions

java.lang.Object

com.arangodb.model.arangosearch.ArangoSearchPropertiesOptions

public final class ArangoSearchPropertiesOptions
extends Object

Author:

Mark Vollmary

Constructor Summary

Constructors

Constructor and Description
ArangoSearchPropertiesOptions()

Method Summary

Modifier and Type	Method and Description
ArangoSearchPropertiesOptions	cleanupIntervalStep(Long cleanupIntervalStep)
ArangoSearchPropertiesOptions	consolidationIntervalMsec(Long consolidationIntervalMsec)
ArangoSearchPropertiesOptions	consolidationPolicy(ConsolidationPolicy consolidationPolicy)
Long	getCleanupIntervalStep()
Long	getConsolidationIntervalMsec()
ConsolidationPolicy	getConsolidationPolicy()
Collection<CollectionLink>	getLinks()
Collection<PrimarySort>	getPrimarySorts()
ArangoSearchPropertiesOptions	link(CollectionLink... links)
ArangoSearchPropertiesOptions	primarySort(PrimarySort... primarySorts)

Methods inherited from class java.lang.Object

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

Constructor Detail

ArangoSearchPropertiesOptions

public ArangoSearchPropertiesOptions()

Method Detail

consolidationIntervalMsec

public ArangoSearchPropertiesOptions 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

cleanupIntervalStep

public ArangoSearchPropertiesOptions 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 ArangoSearchPropertiesOptions consolidationPolicy(ConsolidationPolicy consolidationPolicy)

Parameters:

consolidationPolicy -

Returns:

options

link

public ArangoSearchPropertiesOptions link(CollectionLink... links)

Parameters:

links - A list of linked collections

Returns:

options

primarySort

public ArangoSearchPropertiesOptions primarySort(PrimarySort... primarySorts)

Parameters:

primarySorts - A list of primarySort objects

Returns:

options

getConsolidationIntervalMsec

public Long getConsolidationIntervalMsec()

getCleanupIntervalStep

public Long getCleanupIntervalStep()

getConsolidationPolicy

public ConsolidationPolicy getConsolidationPolicy()

getLinks

public Collection<CollectionLink> getLinks()

getPrimarySorts

public Collection<PrimarySort> getPrimarySorts()