honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-02-17 02:14:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Add default index-time analyzer example (#50501)

Browse Source 
The Analysis docs mention including a default analyzer in the index settings. However, no example snippet is included.

This adds an example snippet that users can easily copy and adjust.
This commit is contained in:
James Rodewig 2020-01-08 11:06:54 -06:00
parent f3ddd4066a
commit f87e61ec30
1 changed files with 38 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
docs/reference/analysis.asciidoc
View File

@ -35,6 +35,19 @@ to the inverted index:
[[specify-index-time-analyzer]]
=== Specifying an index time analyzer
{es} determines which index-time analyzer to use by
checking the following parameters in order:
. The <<analyzer,`analyzer`>> mapping parameter of the field
. The `default` analyzer parameter in the index settings
If none of these parameters are specified, the
<<analysis-standard-analyzer,`standard` analyzer>> is used.
[discrete]
[[specify-index-time-field-analyzer]]
==== Specify the index-time analyzer for a field
Each <<text,`text`>> field in a mapping can specify its own
<<analyzer,`analyzer`>>:
@ -53,10 +66,32 @@ PUT my_index
}
-------------------------
At index time, if no `analyzer` has been specified, it looks for an analyzer
in the index settings called `default`. Failing that, it defaults to using
the <<analysis-standard-analyzer,`standard` analyzer>>.
[discrete]
[[specify-index-time-default-analyzer]]
==== Specify a default index-time analyzer
When <<indices-create-index,creating an index>>, you can set a default
index-time analyzer using the `default` analyzer setting:
[source,console]
----
PUT my_index
{
"settings": {
"analysis": {
"analyzer": {
"default": {
"type": "whitespace"
}
}
}
}
}
----
A default index-time analyzer is useful when mapping multiple `text` fields that
use the same analyzer. It's also used as a general fallback analyzer for both
index-time and search-time analysis.
[float]
== Search time analysis