Options
All
  • Public
  • Public/Protected
  • All
Menu

Schema for a json or text query index definition. Indexes of type text have additional configuration properties that do not apply to json indexes, these are: * default_analyzer - the default text analyzer to use * default_field - whether to index the text in all document fields and what analyzer to use for that purpose.

Hierarchy

  • IndexDefinition

Index

Properties

Optional default_analyzer

default_analyzer: Analyzer

Schema for a full text search analyzer.

Optional default_field

Schema for the text index default field configuration. The default field is used to index the text of all fields within a document for use with the $text operator.

Optional fields

fields: IndexField[]

List of fields to index.

Optional index_array_lengths

index_array_lengths: boolean

Whether to scan every document for arrays and store the length for each array found. Set the index_array_lengths field to false if:

  • You do not need to know the length of an array. * You do not use the $size operator. * The documents in your database are complex, or not completely under your control. As a result, it is difficult to estimate the impact of the extra processing that is needed to determine and store the arrays lengths.

Generated using TypeDoc