Add docs for the fields retrieval API. #58787
Merged
Conversation
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
jtibshirani
added
>docs
Collaborator
|
Pinging @elastic/es-docs (>docs) |
Collaborator
|
Pinging @elastic/es-search (:Search/Search) |
Contributor
Author
|
There are so many options to load fields now, it will be important to simplify this in a follow-up effort. Some ideas (not for this PR, just giving context):
|
jtibshirani
force-pushed
the
fields-param-docs
branch
2 times, most recently
from
c18087b to
fa97ad0
Compare
jtibshirani
force-pushed
the
fields-param-docs
branch
from
fa97ad0 to
9317815
Compare
nik9000
reviewed
Jun 30, 2020
| The `fields` parameter consults both a document's `_source` and the index | ||
| mappings to load and return values. Because it makes use of the mappings, | ||
| `fields` has some advantages over referencing the `_source` directly: it | ||
| accepts <<multi-fields, multi-fields>> and <<alias, field aliases>>, and |
Member
There was a problem hiding this comment.
I think if we're going to tell people to use this API we should compare everything to it. In other words, I think this information belongs in a section on _source.
Contributor
Author
There was a problem hiding this comment.
Could you explain a bit more what you mean here?
Member
There was a problem hiding this comment.
I'm not sure I can express it super well. How would you feel about merging as is and I can open a follow up at some point?
Contributor
Author
There was a problem hiding this comment.
That works for me -- we could also chat offline if it's helpful. I do think that if we advocate always using the fields API, we should stop presenting it as an alternative to _source (and maybe stop returning the _source by default)? We can think about this when considering follow-ups.
10 tasks
jtibshirani
added a commit
that referenced
this pull request
Jul 8, 2020
This PR adds docs for the `fields` parameter. We now present `fields` as the preferred way to load specific fields in a search, with `docvalue_fields` and `stored_fields` as other options to look into. Source filtering is no longer featured prominently, and its section is moved to the end.
jtibshirani
added a commit
that referenced
this pull request
Jul 14, 2020
This PR adds docs for the `fields` parameter. We now present `fields` as the preferred way to load specific fields in a search, with `docvalue_fields` and `stored_fields` as other options to look into. Source filtering is no longer featured prominently, and its section is moved to the end.
jtibshirani
added a commit
that referenced
this pull request
Jul 15, 2020
This PR adds docs for the `fields` parameter. We now present `fields` as the preferred way to load specific fields in a search, with `docvalue_fields` and `stored_fields` as other options to look into. Source filtering is no longer featured prominently, and its section is moved to the end.
jtibshirani
added a commit
that referenced
this pull request
Jul 16, 2020
This PR adds docs for the `fields` parameter. We now present `fields` as the preferred way to load specific fields in a search, with `docvalue_fields` and `stored_fields` as other options to look into. Source filtering is no longer featured prominently, and its section is moved to the end.
jtibshirani
added a commit
that referenced
this pull request
Jul 18, 2020
This PR adds docs for the `fields` parameter. We now present `fields` as the preferred way to load specific fields in a search, with `docvalue_fields` and `stored_fields` as other options to look into. Source filtering is no longer featured prominently, and its section is moved to the end.
jtibshirani
added a commit
that referenced
this pull request
Jul 21, 2020
This PR adds docs for the `fields` parameter. We now present `fields` as the preferred way to load specific fields in a search, with `docvalue_fields` and `stored_fields` as other options to look into. Source filtering is no longer featured prominently, and its section is moved to the end.
jtibshirani
added a commit
that referenced
this pull request
Jul 23, 2020
This PR adds docs for the `fields` parameter. We now present `fields` as the preferred way to load specific fields in a search, with `docvalue_fields` and `stored_fields` as other options to look into. Source filtering is no longer featured prominently, and its section is moved to the end.
jtibshirani
added a commit
to jtibshirani/elasticsearch
that referenced
this pull request
Jul 27, 2020
This PR adds docs for the `fields` parameter. We now present `fields` as the preferred way to load specific fields in a search, with `docvalue_fields` and `stored_fields` as other options to look into. Source filtering is no longer featured prominently, and its section is moved to the end.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This PR adds docs for the
fieldsparameter. We now presentfieldsas thepreferred way to load specific fields in a search, with
docvalue_fieldsandstored_fieldsas other options to look into. Source filtering is no longerfeatured prominently, and its section is moved to the end.
Relates to #55363.