Add _id
to the result of helpers.search
#2432
Merged
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.
Overview
This PR adds the
_id
field to the object returned byhelpers.search
.Motivation
A vast majority of my use cases require knowing the IDs of the documents being fetched, which is why I end up using instead the regular
search
function instead of thehelpers.search
handy helper.Additional considerations
At first I thought about adding an extra parameter to the function (
extraOptions
?), but after some consideration, I'm not sure that changing the existing behavior would be disruptive.Still, I don't mind re-implementing this feature in any other manner.
Some notes
_id
is an illegal field name, meaning_source
will never include it.@es_quirk
I'm referring to in the comments (exists since version 8.14.0):