honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-02-24 05:44:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Correct guidance for index_options mapping parm (#52899)

Browse Source 
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.
This commit is contained in:
James Rodewig 2020-03-02 07:37:48 -05:00
parent 7eb4c07f1f
commit f5bccad847
1 changed files with 20 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/reference/mapping/params/index-options.asciidoc
View File

@ -2,37 +2,34 @@
=== `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.
[WARNING]
====
The `index_options` parameter is intended for use with <<text,`text`>> fields
only. Avoid using `index_options` with other field datatypes.
====
It accepts the following values:
[horizontal]
`docs`::
Only the doc number is indexed. Can answer the question _Does this term
exist in this field?_
`freqs`::
Doc number and term frequencies are indexed. Term frequencies are used to
score repeated terms higher than single terms.
`positions`::
`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.
[source,console]
--------------------------------------------------
PUT my_index