Type alias InvertedIndexNestedFieldOptions

InvertedIndexNestedFieldOptions: {
    analyzer?: string;
    features?: AnalyzerFeature[];
    name: string;
    nested?: (string | InvertedIndexNestedFieldOptions)[];
    searchField?: boolean;
}

(Enterprise Edition only.) Options for a nested field in an inverted index.

Type declaration

  • Optional analyzer?: string

    Name of the Analyzer to apply to the values of this field.

    Defaults to the analyzer specified on the parent options or on the index itself.

  • Optional features?: AnalyzerFeature[]

    List of Analyzer features to enable for this field's Analyzer.

    Defaults to the features of the Analyzer.

  • name: string

    An attribute path.

  • Optional nested?: (string | InvertedIndexNestedFieldOptions)[]

    Sub-objects to index to allow querying for co-occurring values.

  • Optional searchField?: boolean

    If set to true array values will be indexed using the same behavior as ArangoSearch Views. This option only applies when using the index in a SearchAlias View.

    Defaults to the value of searchField specified on the index itself.

Settings

Theme

Generated using TypeDoc