-
Notifications
You must be signed in to change notification settings - Fork 25.3k
Add a reference on returning fields during a search. #57500
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -285,3 +285,5 @@ GET /*/_search | |
==== | ||
|
||
include::request/from-size.asciidoc[] | ||
|
||
include::search-fields.asciidoc[] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.