A reason for index's exclusion.

Constructors

Properties

Methods

Constructors

Properties

name?: string

A reason code for index's exclusion.

The full list of possible reason codes is following:

  • alphabetically_comes_after: json There is another suitable index whose name comes before that of this index.
  • empty_selector: text "text" indexes do not support queries with empty selectors.
  • excluded_by_user: any use_index was used to manually specify the index.
  • field_mismatch: any Fields in "selector" of the query do match with the fields available in the index.
  • is_partial: json, text Partial indexes can be selected only manually.
  • less_overlap: json There is a better match of fields available within the indexes for the query.
  • needs_text_search: json The use of the $text operator requires a "text" index.
  • scope_mismatch: json The scope of the query and the index is not the same.
  • sort_order_mismatch: json, special Fields in "sort" of the query do not match with the fields available in the index.
  • too_many_fields: json The index has more fields than the chosen one.
  • unfavored_type: any The type of the index is not preferred.

Methods