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

Improve documentation of the new disabled field data format.

Browse Source
This commit is contained in:
Adrien Grand 2013-12-18 15:44:57 +01:00
parent 17e7d01753
commit 07443089ce
1 changed files with 24 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/reference/index-modules/fielddata.asciidoc
View File

@ -57,18 +57,6 @@ alive while new segments will use the new field data configuration. Thanks to
the background merging process, all segments will eventually use the new the background merging process, all segments will eventually use the new
field data format. field data format.
[float]
==== Disallowing field data loading
Field data can take a lot of RAM so it makes sense to disable field data
loading on the fields that don't need field data, for example those that are
used for full-text search only. In order to disable field data loading, just
change the field data type to `disabled`. Request that will try to load field
data on any field which is configured with this format will then return an
error.
The `disabled` format is supported by all field types.
[float] [float]
==== String field data types ==== String field data types
@ -124,6 +112,30 @@ It is possible to force field data to be loaded and cached eagerly through the
} }
-------------------------------------------------- --------------------------------------------------
[float]
==== Disabling field data loading
Field data can take a lot of RAM so it makes sense to disable field data
loading on the fields that don't need field data, for example those that are
used for full-text search only. In order to disable field data loading, just
change the field data format to `disabled`. Request that will try to load field
data on any field which is configured with this format will then return an
error.
[source,js]
--------------------------------------------------
{
text: {
type: "string",
fielddata: {
format: "disabled"
}
}
}
--------------------------------------------------
The `disabled` format is supported by all field types.
[float] [float]
[[field-data-filtering]] [[field-data-filtering]]
=== Filtering fielddata === Filtering fielddata