ArangoSearchProperties (arangodb-java-driver 6.24.0 API)

java.lang.Object
- com.arangodb.entity.arangosearch.ArangoSearchProperties

```
public class ArangoSearchProperties
extends Object
```
Author:

Mark Vollmary, Heiko Kernbach, Michele Rastelli

See Also:

API Documentation

Constructor Summary

Constructors
Constructor and Description

ArangoSearchProperties()

Constructors
Constructor and Description
`ArangoSearchProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addLink(CollectionLink... links)`
`void`	`addPrimarySort(PrimarySort... primarySorts)`
`void`	`addStoredValues(StoredValue... storedValues)`
`Long`	`getCleanupIntervalStep()`
`Long`	`getCommitIntervalMsec()`
`Long`	`getConsolidationIntervalMsec()`
`ConsolidationPolicy`	`getConsolidationPolicy()`
`Collection<CollectionLink>`	`getLinks()`
`Boolean`	`getPrimaryKeyCache()`
`Collection<PrimarySort>`	`getPrimarySort()`
`Boolean`	`getPrimarySortCache()`
`ArangoSearchCompression`	`getPrimarySortCompression()`
`Collection<StoredValue>`	`getStoredValues()`
`void`	`setCleanupIntervalStep(Long cleanupIntervalStep)`
`void`	`setCommitIntervalMsec(Long commitIntervalMsec)`
`void`	`setConsolidationIntervalMsec(Long consolidationIntervalMsec)`
`void`	`setConsolidationPolicy(ConsolidationPolicy consolidationPolicy)`
`void`	`setPrimaryKeyCache(Boolean primaryKeyCache)`
`void`	`setPrimarySortCache(Boolean primarySortCache)`
`void`	`setPrimarySortCompression(ArangoSearchCompression primarySortCompression)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ArangoSearchProperties
```
public ArangoSearchProperties()
```
- Method Detail
  - getCommitIntervalMsec
```
public Long getCommitIntervalMsec()
```
  - setCommitIntervalMsec
```
public void setCommitIntervalMsec(Long commitIntervalMsec)
```
  - getConsolidationIntervalMsec
```
public Long getConsolidationIntervalMsec()
```
  - setConsolidationIntervalMsec
```
public void setConsolidationIntervalMsec(Long consolidationIntervalMsec)
```
  - getCleanupIntervalStep
```
public Long getCleanupIntervalStep()
```
  - setCleanupIntervalStep
```
public void setCleanupIntervalStep(Long cleanupIntervalStep)
```
  - getConsolidationPolicy
```
public ConsolidationPolicy getConsolidationPolicy()
```
  - setConsolidationPolicy
```
public void setConsolidationPolicy(ConsolidationPolicy consolidationPolicy)
```
  - getLinks
```
public Collection<CollectionLink> getLinks()
```
  - addLink
```
public void addLink(CollectionLink... links)
```
  - getPrimarySort
```
public Collection<PrimarySort> getPrimarySort()
```
  - addPrimarySort
```
public void addPrimarySort(PrimarySort... primarySorts)
```
  - 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
  - setPrimarySortCompression
```
public void setPrimarySortCompression(ArangoSearchCompression primarySortCompression)
```
  - 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
  - addStoredValues
```
public void addStoredValues(StoredValue... storedValues)
```
  - getPrimarySortCache
```
public Boolean getPrimarySortCache()
```
  - setPrimarySortCache
```
public void setPrimarySortCache(Boolean primarySortCache)
```
    Parameters:
    
    primarySortCache - If you enable this option, then the primary sort columns are always cached in memory. This can improve the performance of queries that utilize the primary sort order. Otherwise, these values are memory-mapped and it is up to the operating system to load them from disk into memory and to evict them from memory.
    
    Since:
    
    ArangoDB 3.9.6, Enterprise Edition only
  - getPrimaryKeyCache
```
public Boolean getPrimaryKeyCache()
```
  - setPrimaryKeyCache
```
public void setPrimaryKeyCache(Boolean primaryKeyCache)
```
    Parameters:
    
    primaryKeyCache - If you enable this option, then the primary key columns are always cached in memory. This can improve the performance of queries that return many documents. Otherwise, these values are memory-mapped and it is up to the operating system to load them from disk into memory and to evict them from memory.
    
    Since:
    
    ArangoDB 3.9.6, Enterprise Edition only

Class ArangoSearchProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ArangoSearchProperties

Method Detail

getCommitIntervalMsec

setCommitIntervalMsec

getConsolidationIntervalMsec

setConsolidationIntervalMsec

getCleanupIntervalStep

setCleanupIntervalStep

getConsolidationPolicy

setConsolidationPolicy

getLinks

addLink

getPrimarySort

addPrimarySort

getPrimarySortCompression

setPrimarySortCompression

getStoredValues

addStoredValues

getPrimarySortCache

setPrimarySortCache

getPrimaryKeyCache

setPrimaryKeyCache