com.arangodb.model

Class PersistentIndexOptions

java.lang.Object

com.arangodb.model.IndexOptions<PersistentIndexOptions>

com.arangodb.model.PersistentIndexOptions

public class PersistentIndexOptions
extends IndexOptions<PersistentIndexOptions>

Author:

Mark Vollmary

See Also:

API Documentation

Field Summary

Fields

Modifier and Type	Field and Description
protected IndexType	type

Constructor Summary

Constructors

Constructor and Description
PersistentIndexOptions()

Method Summary

Modifier and Type	Method and Description
PersistentIndexOptions	estimates(Boolean estimates)
protected PersistentIndexOptions	fields(Iterable<String> fields)
Boolean	getEstimates()
protected Iterable<String>	getFields()
Boolean	getSparse()
protected PersistentIndexOptions	getThis()
protected IndexType	getType()
Boolean	getUnique()
PersistentIndexOptions	sparse(Boolean sparse)
PersistentIndexOptions	unique(Boolean unique)

Methods inherited from class com.arangodb.model.IndexOptions

getInBackground, getName, inBackground, name

Methods inherited from class java.lang.Object

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

Field Detail

type

protected final IndexType type

Constructor Detail

PersistentIndexOptions

public PersistentIndexOptions()

Method Detail

getThis

protected PersistentIndexOptions getThis()

Specified by:

getThis in class IndexOptions<PersistentIndexOptions>

getFields

protected Iterable<String> getFields()

fields

protected PersistentIndexOptions fields(Iterable<String> fields)

Parameters:

fields - A list of attribute paths

Returns:

options

getType

protected 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

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()