mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-12 16:05:28 +00:00
36a3b84fc9
* Default include_type_name to false for get and put mappings. * Default include_type_name to false for get field mappings. * Add a constant for the default include_type_name value. * Default include_type_name to false for get and put index templates. * Default include_type_name to false for create index. * Update create index calls in REST documentation to use include_type_name=true. * Some minor clean-ups around the get index API. * In REST tests, use include_type_name=true by default for index creation. * Make sure to use 'expression == false'. * Clarify the different IndexTemplateMetaData toXContent methods. * Fix FullClusterRestartIT#testSnapshotRestore. * Fix the ml_anomalies_default_mappings test. * Fix GetFieldMappingsResponseTests and GetIndexTemplateResponseTests. We make sure to specify include_type_name=true during xContent parsing, so we continue to test the legacy typed responses. XContent generation for the typeless responses is currently only covered by REST tests, but we will be adding unit test coverage for these as we implement each typeless API in the Java HLRC. This commit also refactors GetMappingsResponse to follow the same appraoch as the other mappings-related responses, where we read include_type_name out of the xContent params, instead of creating a second toXContent method. This gives better consistency in the response parsing code. * Fix more REST tests. * Improve some wording in the create index documentation. * Add a note about types removal in the create index docs. * Fix SmokeTestMonitoringWithSecurityIT#testHTTPExporterWithSSL. * Make sure to mention include_type_name in the REST docs for affected APIs. * Make sure to use 'expression == false' in FullClusterRestartIT. * Mention include_type_name in the REST templates docs.
73 lines
1.7 KiB
Plaintext
73 lines
1.7 KiB
Plaintext
[[index-options]]
|
|
=== `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:
|
|
|
|
[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`::
|
|
|
|
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.
|
|
|
|
<<mapping-index,Analyzed>> string fields use `positions` as the default, and
|
|
all other fields use `docs` as the default.
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
PUT my_index?include_type_name=true
|
|
{
|
|
"mappings": {
|
|
"_doc": {
|
|
"properties": {
|
|
"text": {
|
|
"type": "text",
|
|
"index_options": "offsets"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
PUT my_index/_doc/1
|
|
{
|
|
"text": "Quick brown fox"
|
|
}
|
|
|
|
GET my_index/_search
|
|
{
|
|
"query": {
|
|
"match": {
|
|
"text": "brown fox"
|
|
}
|
|
},
|
|
"highlight": {
|
|
"fields": {
|
|
"text": {} <1>
|
|
}
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
<1> The `text` field will use the postings for the highlighting by default because `offsets` are indexed.
|