Package com.arangodb.model

Class PersistentIndexOptions

java.lang.Object
com.arangodb.model.IndexOptions<PersistentIndexOptions>
com.arangodb.model.PersistentIndexOptions
public final class PersistentIndexOptions extends IndexOptions<PersistentIndexOptions>
Author:
Mark Vollmary

  • Constructor Details

    • PersistentIndexOptions

      public PersistentIndexOptions()

  • Method Details

    • getFields

      public Iterable<String> getFields()

    • getType

      public IndexType getType()

    • getUnique

      public Boolean getUnique()

    • unique

      public PersistentIndexOptions unique(Boolean unique)
      Parameters:
      unique - if true, then create a unique index
      Returns:
      options

    • getSparse

      public Boolean getSparse()

    • sparse

      public PersistentIndexOptions sparse(Boolean sparse)
      Parameters:
      sparse - if true, then create a sparse index
      Returns:
      options

    • getDeduplicate

      public Boolean getDeduplicate()

    • deduplicate

      public PersistentIndexOptions deduplicate(Boolean deduplicate)
      Parameters:
      deduplicate - if false, the deduplication of array values is turned off. Default: true
      Returns:
      options

    • estimates

      public PersistentIndexOptions estimates(Boolean estimates)
      Parameters:
      estimates - This attribute controls whether index selectivity estimates are maintained for the index. Default: true
      Since:
      ArangoDB 3.8

    • getEstimates

      public Boolean getEstimates()

    • cacheEnabled

      public PersistentIndexOptions cacheEnabled(Boolean cacheEnabled)
      Parameters:
      cacheEnabled - enables in-memory caching of index entries
      Returns:
      options
      Since:
      ArangoDB 3.10

    • getCacheEnabled

      public Boolean getCacheEnabled()

    • getStoredValues

      public Collection<String> getStoredValues()

    • storedValues

      public PersistentIndexOptions storedValues(String... storedValues)
      Parameters:
      storedValues - (optional) array of paths to additional attributes to store in the index. These additional attributes cannot be used for index lookups or for sorting, but they can be used for projections. This allows an index to fully cover more queries and avoid extra document lookups. The maximum number of attributes in `storedValues` is 32.
      Returns:
      options