prorm API Reference
    Preparing search index...

    Interface ArangoCreateIndexOptions

    Options for createIndex(). Which fields are meaningful depends on type.

    interface ArangoCreateIndexOptions {
        type: ArangoIndexType;
        fields: string[];
        name?: string;
        unique?: boolean;
        sparse?: boolean;
        geoJson?: boolean;
        minLength?: number;
        expireAfter?: number;
        inBackground?: boolean;
    }
    Index
    type fields name? unique? sparse? geoJson? minLength? expireAfter? inBackground?
    type: ArangoIndexType
    fields: string[]

    Document fields the index covers (e.g. ['email'], ['location']).

    name?: string

    Explicit index name. Auto-generated by the server if omitted.

    unique?: boolean

    persistent/hash/skiplist: enforce uniqueness of the indexed field(s).

    sparse?: boolean

    persistent/hash/skiplist/geo: exclude documents missing the indexed field(s).

    geoJson?: boolean

    geo: interpret the indexed field as a GeoJSON object rather than [lat, lon].

    minLength?: number

    fulltext: minimum word length to index.

    expireAfter?: number

    ttl: seconds after the indexed timestamp field at which documents expire.

    inBackground?: boolean

    Build the index without blocking other operations on the collection.

    Settings
    Member Visibility

    On This Page
    Properties