Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "indexes"

import type { Index } from "arangojs/indexes";

TODO

Index

Type aliases

Type aliases

EnsureIndexFulltextOptions

EnsureIndexFulltextOptions: { fields: [string]; minLength?: undefined | number; name?: undefined | string; type: "fulltext" }

TODO

Type declaration

  • fields: [string]
  • Optional minLength?: undefined | number
  • Optional name?: undefined | string
  • type: "fulltext"

EnsureIndexGeoOptions

EnsureIndexGeoOptions: { fields: [string] | [string, string]; geoJson?: undefined | false | true; name?: undefined | string; type: "geo" }

TODO

Type declaration

  • fields: [string] | [string, string]
  • Optional geoJson?: undefined | false | true
  • Optional name?: undefined | string
  • type: "geo"

EnsureIndexHashOptions

EnsureIndexHashOptions: { deduplicate?: undefined | false | true; fields: string[]; name?: undefined | string; sparse?: undefined | false | true; type: "hash"; unique?: undefined | false | true }

TODO

Type declaration

  • Optional deduplicate?: undefined | false | true
  • fields: string[]
  • Optional name?: undefined | string
  • Optional sparse?: undefined | false | true
  • type: "hash"
  • Optional unique?: undefined | false | true

EnsureIndexPersistentOptions

EnsureIndexPersistentOptions: { fields: string[]; name?: undefined | string; sparse?: undefined | false | true; type: "persistent"; unique?: undefined | false | true }

TODO

Type declaration

  • fields: string[]
  • Optional name?: undefined | string
  • Optional sparse?: undefined | false | true
  • type: "persistent"
  • Optional unique?: undefined | false | true

EnsureIndexSkiplistOptions

EnsureIndexSkiplistOptions: { deduplicate?: undefined | false | true; fields: string[]; name?: undefined | string; sparse?: undefined | false | true; type: "skiplist"; unique?: undefined | false | true }

TODO

Type declaration

  • Optional deduplicate?: undefined | false | true
  • fields: string[]
  • Optional name?: undefined | string
  • Optional sparse?: undefined | false | true
  • type: "skiplist"
  • Optional unique?: undefined | false | true

EnsureIndexTtlOptions

EnsureIndexTtlOptions: { expireAfter: number; fields: [string]; name?: undefined | string; type: "ttl" }

TODO

Type declaration

  • expireAfter: number
  • fields: [string]
  • Optional name?: undefined | string
  • type: "ttl"

FulltextIndex

FulltextIndex: GenericIndex & { fields: [string]; minLength: number; type: "fulltext" }

TODO

GenericIndex

GenericIndex: { id: string; name?: undefined | string; sparse: boolean; unique: boolean }

TODO

Type declaration

  • id: string
  • Optional name?: undefined | string
  • sparse: boolean
  • unique: boolean

GeoIndex

GeoIndex: GenericIndex & { bestIndexedLevel: number; fields: [string] | [string, string]; geoJson: boolean; maxNumCoverCells: number; type: "geo"; worstIndexedLevel: number }

TODO

HashIndex

HashIndex: GenericIndex & { fields: string[]; selectivityEstimate: number; type: "hash" }

(MMFiles only.) TODO

When using the RocksDB storage engine, this index type behaves identically to PersistentIndex.

Index

Index: GeoIndex | FulltextIndex | PersistentIndex | PrimaryIndex | HashIndex | SkiplistIndex | TtlIndex

TODO

IndexSelector

IndexSelector: string | Index

TODO

PersistentIndex

PersistentIndex: GenericIndex & { fields: string[]; type: "persistent" }

TODO

PrimaryIndex

PrimaryIndex: GenericIndex & { fields: string[]; selectivityEstimate: number; type: "primary" }

TODO

SkiplistIndex

SkiplistIndex: GenericIndex & { fields: string[]; type: "skiplist" }

(MMFiles only.) TODO

When using the RocksDB storage engine, this index type behaves identically to PersistentIndex.

TtlIndex

TtlIndex: GenericIndex & { expireAfter: number; fields: [string]; selectivityEstimate: number; type: "ttl" }

TODO

Generated using TypeDoc