mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-30 18:33:26 -04:00
4b1c116461
Adds infrastructure so `gradle :docs:check` will extract tests from snippets in the documentation and execute the tests. This is included in `gradle check` so it should happen on CI and during a normal build. By default each `// AUTOSENSE` snippet creates a unique REST test. These tests are executed in a random order and the cluster is wiped between each one. If multiple snippets chain together into a test you can annotate all snippets after the first with `// TEST[continued]` to have the generated tests for both snippets joined. Snippets marked as `// TESTRESPONSE` are checked against the response of the last action. See docs/README.asciidoc for lots more. Closes #12583. That issue is about catching bugs in the docs during build. This catches *some* bugs in the docs during build which is a good start.
134 lines
3.4 KiB
Text
134 lines
3.4 KiB
Text
[[multi-fields]]
|
|
=== `fields`
|
|
|
|
It is often useful to index the same field in different ways for different
|
|
purposes. This is the purpose of _multi-fields_. For instance, a `string`
|
|
field could be mapped as a `text` field for full-text
|
|
search, and as a `keyword` field for sorting or aggregations:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
PUT my_index
|
|
{
|
|
"mappings": {
|
|
"my_type": {
|
|
"properties": {
|
|
"city": {
|
|
"type": "text",
|
|
"fields": {
|
|
"raw": { <1>
|
|
"type": "keyword"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
PUT my_index/my_type/1
|
|
{
|
|
"city": "New York"
|
|
}
|
|
|
|
PUT my_index/my_type/2
|
|
{
|
|
"city": "York"
|
|
}
|
|
|
|
GET my_index/_search
|
|
{
|
|
"query": {
|
|
"match": {
|
|
"city": "york" <2>
|
|
}
|
|
},
|
|
"sort": {
|
|
"city.raw": "asc" <3>
|
|
},
|
|
"aggs": {
|
|
"Cities": {
|
|
"terms": {
|
|
"field": "city.raw" <3>
|
|
}
|
|
}
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
// AUTOSENSE
|
|
<1> The `city.raw` field is a `keyword` version of the `city` field.
|
|
<2> The `city` field can be used for full text search.
|
|
<3> The `city.raw` field can be used for sorting and aggregations
|
|
|
|
NOTE: Multi-fields do not change the original `_source` field.
|
|
|
|
TIP: The `fields` setting is allowed to have different settings for fields of
|
|
the same name in the same index. New multi-fields can be added to existing
|
|
fields using the <<indices-put-mapping,PUT mapping API>>.
|
|
|
|
==== Multi-fields with multiple analyzers
|
|
|
|
Another use case of multi-fields is to analyze the same field in different
|
|
ways for better relevance. For instance we could index a field with the
|
|
<<analysis-standard-analyzer,`standard` analyzer>> which breaks text up into
|
|
words, and again with the <<english-analyzer,`english` analyzer>>
|
|
which stems words into their root form:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
PUT my_index
|
|
{
|
|
"mappings": {
|
|
"my_type": {
|
|
"properties": {
|
|
"text": { <1>
|
|
"type": "text",
|
|
"fields": {
|
|
"english": { <2>
|
|
"type": "text",
|
|
"analyzer": "english"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
PUT my_index/my_type/1
|
|
{ "text": "quick brown fox" } <3>
|
|
|
|
PUT my_index/my_type/2
|
|
{ "text": "quick brown foxes" } <3>
|
|
|
|
GET my_index/_search
|
|
{
|
|
"query": {
|
|
"multi_match": {
|
|
"query": "quick brown foxes",
|
|
"fields": [ <4>
|
|
"text",
|
|
"text.english"
|
|
],
|
|
"type": "most_fields" <4>
|
|
}
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
// AUTOSENSE
|
|
|
|
<1> The `text` field uses the `standard` analyzer.
|
|
<2> The `text.english` field uses the `english` analyzer.
|
|
<3> Index two documents, one with `fox` and the other with `foxes`.
|
|
<4> Query both the `text` and `text.english` fields and combine the scores.
|
|
|
|
The `text` field contains the term `fox` in the first document and `foxes` in
|
|
the second document. The `text.english` field contains `fox` for both
|
|
documents, because `foxes` is stemmed to `fox`.
|
|
|
|
The query string is also analyzed by the `standard` analyzer for the `text`
|
|
field, and by the `english` analyzer` for the `text.english` field. The
|
|
stemmed field allows a query for `foxes` to also match the document containing
|
|
just `fox`. This allows us to match as many documents as possible. By also
|
|
querying the unstemmed `text` field, we improve the relevance score of the
|
|
document which matches `foxes` exactly.
|