IndexType uses ConstantsTrait
Type values accepted by the ArangoDB index API as the `type` field of a `POST /_api/index` request (and returned on the response side).
Notes:
primaryandedgeare server-managed and cannot be created throughPOST /_api/index— they are listed here for completeness (the Collection::indexes() listing exposes them as-is).hashandskiplistare aliases ofpersistentsince ArangoDB 3.7 and are intentionally NOT exposed — use PERSISTENT.fulltexthas been deprecated since ArangoDB 3.10 in favour of INVERTED / ArangoSearch views.
Tags
Table of Contents
Constants
- EDGE : string = 'edge'
- Built-in edge index automatically created on every edge collection.
- FULLTEXT : string = 'fulltext'
- Full-text inverted index. Deprecated since ArangoDB 3.10 in favour of {@see INVERTED} / ArangoSearch views.
- GEO : string = 'geo'
- Geospatial index (point or polygon-aware).
- INVERTED : string = 'inverted'
- Inverted index (ArangoSearch-backed). Replacement for `fulltext`.
- MDI : string = 'mdi'
- Multi-dimensional index (stable since ArangoDB 3.12).
- MDI_PREFIXED : string = 'mdi-prefixed'
- Multi-dimensional index with explicit prefix fields (ArangoDB 3.12+).
- PERSISTENT : string = 'persistent'
- Persistent (B-tree) index — the default for most use cases.
- PRIMARY : string = 'primary'
- Built-in primary index automatically created on every collection (`_key` lookup). Cannot be created manually; listed for completeness.
- TTL : string = 'ttl'
- Time-to-live index that removes documents past their `expireAfter` threshold.
- VECTOR : string = 'vector'
- Vector index (ArangoDB 3.13+, Faiss-backed). Used for similarity search over embedding vectors.
Constants
EDGE
Built-in edge index automatically created on every edge collection.
public
string
EDGE
= 'edge'
Cannot be created manually; listed for completeness.
FULLTEXT
Full-text inverted index. Deprecated since ArangoDB 3.10 in favour of {@see INVERTED} / ArangoSearch views.
public
string
FULLTEXT
= 'fulltext'
GEO
Geospatial index (point or polygon-aware).
public
string
GEO
= 'geo'
INVERTED
Inverted index (ArangoSearch-backed). Replacement for `fulltext`.
public
string
INVERTED
= 'inverted'
MDI
Multi-dimensional index (stable since ArangoDB 3.12).
public
string
MDI
= 'mdi'
MDI_PREFIXED
Multi-dimensional index with explicit prefix fields (ArangoDB 3.12+).
public
string
MDI_PREFIXED
= 'mdi-prefixed'
Returned automatically by MDIIndex::toArray()
when prefixFields is provided.
PERSISTENT
Persistent (B-tree) index — the default for most use cases.
public
string
PERSISTENT
= 'persistent'
Replaces the legacy hash and skiplist types since ArangoDB 3.7.
PRIMARY
Built-in primary index automatically created on every collection (`_key` lookup). Cannot be created manually; listed for completeness.
public
string
PRIMARY
= 'primary'
TTL
Time-to-live index that removes documents past their `expireAfter` threshold.
public
string
TTL
= 'ttl'
VECTOR
Vector index (ArangoDB 3.13+, Faiss-backed). Used for similarity search over embedding vectors.
public
string
VECTOR
= 'vector'