Skip to content

Commit

Permalink
Add a reference on returning fields during a search. (#57500)
Browse files Browse the repository at this point in the history
This PR adds a section to the new 'run a search' reference that explains
the options for returning fields. Previously each option was only listed as a
separate request parameter and it was hard to know what was available.
  • Loading branch information
jtibshirani authored Jun 3, 2020
1 parent 29b5643 commit de9b91f
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/reference/search/run-a-search.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -285,3 +285,5 @@ GET /*/_search
====

include::request/from-size.asciidoc[]

include::search-fields.asciidoc[]
31 changes: 31 additions & 0 deletions docs/reference/search/search-fields.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
[discrete]
[[search-fields]]
=== Return fields in a search

By default, each hit in the search response includes the document
<<mapping-source-field,`_source`>>, which is the entire JSON object that was
provided when indexing the document. If you only need certain fields in the
search response, you can use
<<request-body-search-source-filtering,source filtering>> to restrict what
parts of the source are returned.

Returning fields using only the document source has some limitations:

* The `_source` field does not include <<multi-fields, multi-fields>> or
<<alias, field aliases>>. Likewise, a field in the source does not contain
values copied using the <<copy-to,`copy_to`>> mapping parameter.
* Since the `_source` is stored as a single field in Lucene, the whole source
object must be loaded and parsed, even if only a small number of fields are
needed.

{es} supports some alternative methods for returning fields that help avoid
these downsides:

* The <<request-body-search-docvalue-fields, `docvalue_fields`>>
parameter allows for loading fields from their doc values. This can be a good
choice when returning a fairly small number of fields that support doc values,
such as keywords and dates.
* It's also possible to store an individual field's values by using the
<<mapping-store,`store`>> mapping option. You can use the
<<request-body-search-stored-fields, `stored_fields`>> parameter to return
these stored values in the search response.

0 comments on commit de9b91f

Please sign in to comment.