Type alias EnsureFulltextIndexOptions

EnsureFulltextIndexOptions: { fields: [string]; inBackground?: boolean; minLength?: number; name?: string; type: "fulltext" }

Options for creating a fulltext index.

Deprecated

Fulltext indexes have been deprecated in ArangoDB 3.10 and should be replaced with ArangoSearch.

Type declaration

  • fields: [string]

    An array containing exactly one attribute path.

  • Optional inBackground?: boolean

    If set to true, the index will be created in the background to reduce the write-lock duration for the collection during index creation.

    Default: false

  • Optional minLength?: number

    Minimum character length of words to index.

  • Optional name?: string

    A unique name for this index.

  • type: "fulltext"

    Type of this index.

Settings

Theme

Generated using TypeDoc