IndexField uses ConstantsTrait

JSON field names exchanged with the ArangoDB index API (`/_api/index`), on both the request side (body of `POST /_api/index`) and the response side (entries of `GET /_api/index?collection=…` and `GET /_api/index/{id}`).

Tags

see

https://docs.arangodb.com/stable/develop/http-api/indexes/

author

Marc Alcaraz (ekameleon)

since

1.0.0

Table of Contents

Constants

ANALYZER  : string = 'analyzer'

Analyzer name applied at the top level of an inverted index (`inverted` only).

ASC  : string = 'asc'

Ascending-direction flag the server stores for each `primarySort` field (`{ field, asc:bool }`, `inverted` only) — the response-side counterpart of the request-side {@see DIRECTION}.

CACHE  : string = 'cache'

Whether inverted-index entries are cached in memory (`inverted` only).

CACHE_ENABLED  : string = 'cacheEnabled'

Whether the persistent index should keep an in-memory cache of frequently accessed entries (`persistent` only).

CLEANUP_INTERVAL_STEP  : string = 'cleanupIntervalStep'

Frequency at which obsolete segments are cleaned up (`inverted` only).

COMMIT_INTERVAL_MSEC  : string = 'commitIntervalMsec'

Commit interval, in milliseconds, between two index updates (`inverted` only).

CONSOLIDATION_INTERVAL_MSEC  : string = 'consolidationIntervalMsec'

Consolidation interval, in milliseconds, between two segment merges (`inverted` only).

DEDUPLICATE  : string = 'deduplicate'

Whether duplicate documents matching a unique index should be silently deduplicated rather than rejected (`persistent` only).

DIRECTION  : string = 'direction'

Sort direction declared for a `primarySort` field (`{ field, direction:"asc"|"desc" }`, `inverted` only) — the request-side counterpart of the response-side {@see ASC}.

ESTIMATES  : string = 'estimates'

Whether the index should maintain selectivity estimates for the query optimizer.

EXPIRE_AFTER  : string = 'expireAfter'

Document lifetime (in seconds) past which documents are deleted by the TTL background task. Required for `ttl` indexes.

FEATURES  : string = 'features'

Per-field features kept by an inverted index — typically a subset of `frequency`, `position`, `offset`, `norm` (`inverted` only).

FIELD_VALUE_TYPES  : string = 'fieldValueTypes'

Numeric type stored for each indexed value (`mdi` / `mdi-prefixed` only). Currently the only accepted value is `"double"`.

FIELDS  : string = 'fields'

List of document attribute paths the index applies to.

GEO_JSON  : string = 'geoJson'

Whether the geo index input is expressed as GeoJSON (`{ type: 'Point', coordinates: [lng, lat] }`) rather than as a `[latitude, longitude]` pair (`geo` only).

ID  : string = 'id'

Server-side index handle. Present on every response entry.

IN_BACKGROUND  : string = 'inBackground'

Whether to build the index in the background, without blocking concurrent writes to the collection.

INCLUDE_ALL_FIELDS  : string = 'includeAllFields'

Whether the inverted index covers every attribute of the documents, regardless of `fields` (`inverted` only).

INDEXES  : string = 'indexes'

Wrapper field carrying the listing of indexes in the response of `GET /_api/index?collection=…`.

MIN_LENGTH  : string = 'minLength'

Minimum word length to index, in characters (`fulltext` only).

NAME  : string = 'name'

Optional human-readable index name. Used by {@see \oihana\arango\clients\collection\Collection::dropIndex()} as an alternative to the numeric `id`.

PARALLELISM  : string = 'parallelism'

Parallelism level — number of threads that may build / query the index in parallel (`inverted` / `vector` only).

PARAMS  : string = 'params'

Type-specific structured options (currently used by `vector` to carry the Faiss configuration: `dimensions`, `metric`, `nLists`, `defaultNProbe`, `factory`, …).

PREFIX_FIELDS  : string = 'prefixFields'

Prefix attributes for an `mdi-prefixed` index — must be supplied verbatim on every query that targets the index.

PRIMARY_KEY_CACHE  : string = 'primaryKeyCache'

Whether the inverted index keeps a cache of primary-key values (`inverted` only).

PRIMARY_SORT  : string = 'primarySort'

Primary sort definition of an inverted index (`inverted` only).

SEARCH_FIELD  : string = 'searchField'

Whether the inverted index is a search-only field (no document lookup, `inverted` only).

SPARSE  : string = 'sparse'

Whether to skip documents missing every indexed attribute (`persistent` only).

STORED_VALUES  : string = 'storedValues'

Additional attribute paths kept alongside the index entries to answer covering queries without touching the document (`persistent`, `mdi`, `mdi-prefixed`, `inverted`, `vector`).

TRACK_LIST_POSITIONS  : string = 'trackListPositions'

Whether the inverted index records the positions of each token within the source field (`inverted` only).

TYPE  : string = 'type'

Index type marker — one of {@see IndexType}.

UNIQUE  : string = 'unique'

Whether the index enforces uniqueness across indexed attribute tuples (`persistent` only).