Skip to content

Commit

Permalink
[DOCS] Correct guidance for index_options mapping parm (#52899)
Browse files Browse the repository at this point in the history
Adds a warning admonition stating that the `index_options` mapping
parameter is intended only for `text` fields.

Removes an outdated statement regarding default values for numeric
and other datatypes.
  • Loading branch information
jrodewig authored Mar 2, 2020
1 parent 2d7f480 commit 340c08a
Showing 1 changed file with 20 additions and 23 deletions.
43 changes: 20 additions & 23 deletions docs/reference/mapping/params/index-options.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,36 +2,33 @@
=== `index_options`

The `index_options` parameter controls what information is added to the
inverted index, for search and highlighting purposes. It accepts the
following settings:
inverted index for search and highlighting purposes.

[horizontal]
`docs`::

Only the doc number is indexed. Can answer the question _Does this term
exist in this field?_
[WARNING]
====
The `index_options` parameter is intended for use with <<text,`text`>> fields
only. Avoid using `index_options` with other field datatypes.
====

`freqs`::
It accepts the following values:

Doc number and term frequencies are indexed. Term frequencies are used to
score repeated terms higher than single terms.
`docs`::
Only the doc number is indexed. Can answer the question _Does this term
exist in this field?_

`positions`::
`freqs`::
Doc number and term frequencies are indexed. Term frequencies are used to
score repeated terms higher than single terms.

Doc number, term frequencies, and term positions (or order) are indexed.
Positions can be used for
<<query-dsl-match-query-phrase,proximity or phrase queries>>.
`positions` (default)::
Doc number, term frequencies, and term positions (or order) are indexed.
Positions can be used for
<<query-dsl-match-query-phrase,proximity or phrase queries>>.

`offsets`::

Doc number, term frequencies, positions, and start and end character
offsets (which map the term back to the original string) are indexed.
Offsets are used by the <<unified-highlighter,unified highlighter>> to speed up highlighting.

NOTE: <<number,Numeric fields>> don't support the `index_options` parameter any longer.

<<text,`text`>> fields use `positions` as the default, and all other fields use
`docs` as the default.
Doc number, term frequencies, positions, and start and end character
offsets (which map the term back to the original string) are indexed.
Offsets are used by the <<unified-highlighter,unified highlighter>> to speed up highlighting.

[source,console]
--------------------------------------------------
Expand Down

0 comments on commit 340c08a

Please sign in to comment.