OpenSearch/docs/reference/search/request/docvalue-fields.asciidoc

[[search-request-docvalue-fields]]
=== Doc value Fields

Allows to return the <<doc-values,doc value>> representation of a field for each hit, for
example:

[source,js]
--------------------------------------------------
GET /_search
{
    "query" : {
        "match_all": {}
    },
    "docvalue_fields" : ["test1", "test2"]
}
--------------------------------------------------
// CONSOLE

Doc value fields can work on fields that are not stored.

Note that if the fields parameter specifies fields without docvalues it will try to load the value from the fielddata cache
causing the terms for that field to be loaded to memory (cached), which will result in more memory consumption.
Rename `fields` to `stored_fields` and add `docvalue_fields` `stored_fields` parameter will no longer try to retrieve fields from the _source but will only return stored fields. `fields` will throw an exception if the user uses it. Add `docvalue_fields` as an adjunct to `fielddata_fields` which is deprecated. `docvalue_fields` will try to load the value from the docvalue and fallback to fielddata cache if docvalues are not enabled on that field. Closes #18943 2016-06-21 05:27:27 -04:00			`[[search-request-docvalue-fields]]`
			`=== Doc value Fields`

Fix docs build. 2016-06-23 03:44:33 -04:00			`Allows to return the <<doc-values,doc value>> representation of a field for each hit, for`
Rename `fields` to `stored_fields` and add `docvalue_fields` `stored_fields` parameter will no longer try to retrieve fields from the _source but will only return stored fields. `fields` will throw an exception if the user uses it. Add `docvalue_fields` as an adjunct to `fielddata_fields` which is deprecated. `docvalue_fields` will try to load the value from the docvalue and fallback to fielddata cache if docvalues are not enabled on that field. Closes #18943 2016-06-21 05:27:27 -04:00			`example:`

			`[source,js]`
			`--------------------------------------------------`
			`GET /_search`
			`{`
			`"query" : {`
			`"match_all": {}`
			`},`
			`"docvalue_fields" : ["test1", "test2"]`
			`}`
			`--------------------------------------------------`
			`// CONSOLE`

			`Doc value fields can work on fields that are not stored.`

			`Note that if the fields parameter specifies fields without docvalues it will try to load the value from the fielddata cache`
			`causing the terms for that field to be loaded to memory (cached), which will result in more memory consumption.`