2013-08-28 19:24:34 -04:00
|
|
|
[[search-request-fields]]
|
|
|
|
=== Fields
|
|
|
|
|
2016-06-21 05:27:27 -04:00
|
|
|
WARNING: The `stored_fields` parameter is about fields that are explicitly marked as
|
2015-11-03 05:18:00 -05:00
|
|
|
stored in the mapping, which is off by default and generally not recommended.
|
|
|
|
Use <<search-request-source-filtering,source filtering>> instead to select
|
|
|
|
subsets of the original source document to be returned.
|
|
|
|
|
2013-11-13 10:53:10 -05:00
|
|
|
Allows to selectively load specific stored fields for each document represented
|
|
|
|
by a search hit.
|
2013-08-28 19:24:34 -04:00
|
|
|
|
|
|
|
[source,js]
|
|
|
|
--------------------------------------------------
|
2016-05-18 07:15:19 -04:00
|
|
|
GET /_search
|
2013-08-28 19:24:34 -04:00
|
|
|
{
|
2016-06-21 05:27:27 -04:00
|
|
|
"stored_fields" : ["user", "postDate"],
|
2013-08-28 19:24:34 -04:00
|
|
|
"query" : {
|
|
|
|
"term" : { "user" : "kimchy" }
|
|
|
|
}
|
|
|
|
}
|
|
|
|
--------------------------------------------------
|
2016-05-18 07:15:19 -04:00
|
|
|
// CONSOLE
|
2013-08-28 19:24:34 -04:00
|
|
|
|
|
|
|
`*` can be used to load all stored fields from the document.
|
|
|
|
|
|
|
|
An empty array will cause only the `_id` and `_type` for each hit to be
|
|
|
|
returned, for example:
|
|
|
|
|
|
|
|
[source,js]
|
|
|
|
--------------------------------------------------
|
2016-05-18 07:15:19 -04:00
|
|
|
GET /_search
|
2013-08-28 19:24:34 -04:00
|
|
|
{
|
2016-06-21 05:27:27 -04:00
|
|
|
"stored_fields" : [],
|
2013-08-28 19:24:34 -04:00
|
|
|
"query" : {
|
|
|
|
"term" : { "user" : "kimchy" }
|
|
|
|
}
|
|
|
|
}
|
|
|
|
--------------------------------------------------
|
2016-05-18 07:15:19 -04:00
|
|
|
// CONSOLE
|
2013-08-28 19:24:34 -04:00
|
|
|
|
2013-11-13 10:53:10 -05:00
|
|
|
|
|
|
|
For backwards compatibility, if the fields parameter specifies fields which are not stored (`store` mapping set to
|
|
|
|
`false`), it will load the `_source` and extract it from it. This functionality has been replaced by the
|
|
|
|
<<search-request-source-filtering,source filtering>> parameter.
|
|
|
|
|
2014-01-02 17:38:08 -05:00
|
|
|
Field values fetched from the document it self are always returned as an array. Metadata fields like `_routing` and
|
|
|
|
`_parent` fields are never returned as an array.
|
|
|
|
|
|
|
|
Also only leaf fields can be returned via the `field` option. So object fields can't be returned and such requests
|
|
|
|
will fail.
|
|
|
|
|
2013-08-28 19:24:34 -04:00
|
|
|
Script fields can also be automatically detected and used as fields, so
|
2014-01-02 17:38:08 -05:00
|
|
|
things like `_source.obj1.field1` can be used, though not recommended, as
|
|
|
|
`obj1.field1` will work as well.
|
2013-08-28 19:24:34 -04:00
|
|
|
|