[data.search] Allow search response to follow new hits format #88115
Conversation
This file contains 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
lukasolson
added
review
Feature:Search
|
Pinging @elastic/kibana-app-services (Team:AppServices) |
lizozom
reviewed
Jan 14, 2021
lizozom
reviewed
Jan 14, 2021
rylnd
approved these changes
Jan 19, 2021
lizozom
reviewed
Jan 26, 2021
lukasolson
force-pushed
the
search-legacy-hits-total
branch
from
8906550
to
a86696a
Compare
|
@elasticmachine merge upstream |
1 similar comment
|
@elasticmachine merge upstream |
lizozom
approved these changes
Jan 31, 2021
lukasolson
force-pushed
the
search-legacy-hits-total
branch
from
3aa372f
to
60eabcc
Compare
|
@elasticmachine merge upstream |
💚 Build SucceededMetrics [docs]
History
To update your PR or re-run it, just comment with: |
lukasolson
added a commit
to lukasolson/kibana
that referenced
this pull request
Feb 2, 2021
…c#88115) * [data.search] Allow search response to follow new hits format * Update docs * Fix types * Fix types * Doc updates * Remove declare module * Remove declare module Co-authored-by: Kibana Machine <[email protected]>
lukasolson
added a commit
that referenced
this pull request
Feb 2, 2021
#89951) * [data.search] Allow search response to follow new hits format * Update docs * Fix types * Fix types * Doc updates * Remove declare module * Remove declare module Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Kibana Machine <[email protected]>
gmmorris
added a commit
to lizozom/kibana
that referenced
this pull request
Feb 2, 2021
…om/kibana into pr/89570 * 'sessions/save-all-sessions' of https://github.com/lizozom/kibana: (44 commits) [ML] Functional tests - skip DFA clone tests [Uptime] Fix synthetics detail step count (elastic#89940) Fixes the permissions to require cluster.manage in order to create an index and in order to update an index (elastic#89947) [Security Solution] [Detections] adds log info level for logging in cloud (elastic#89941) [Time to Visualize] Dashboard By Value Testing Lens (elastic#89581) [Uptime] Expand synthetic journey step thumbnail on hover (elastic#89179) TS project refs: Migrates snapshot_restore to a TS Project (elastic#89653) docs: APM 7.11 updates (elastic#89789) move skip to higher level (elastic#86952) Revert "Migrations v2: don't auto-create indices + FTR/esArchiver support (elastic#85778)" Revert "Revert "Enable v2 so migrations, disable in FTR tests (elastic#89297)"" Revert "Enable v2 so migrations, disable in FTR tests (elastic#89297)" [data.search] Allow search response to follow new hits format (elastic#88115) [Maps] Change 'create multi-layer map' title to be use-case focused (elastic#89520) skip flaky suite (elastic#86952) [Security Solution] Remove focustrap (elastic#89905) [Workplace Search] Add remaining i18n support for the Content Sources tree (elastic#89910) [esArchiver] log when migrations complete and we're done loading data (elastic#89938) Add --ssl flag to make resolver generator use ssl with kbn and elasticsearch clients (elastic#89873) TS project refs: Migrates grokdebugger (elastic#89652) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Closes #55974.
When making a search request to Elasticsearch, the
hits.totalformat comes back as follows:However, we are currently shimming the old response format, which looks like this:
{"hits": {"total": 8504}}The shimming prior to this PR was happening in the route and bfetch handlers, which didn't make sense so I moved it directly inside the search strategies. This PR also adds a new option,
legacyHitsTotal, to the options you can provide a search request (ISearchOptions). When set totrue(the default), we will continue to shim the old response format. When set tofalse, we will return the response format as-is from Elasticsearch. This gives applications the ability to migrate to the new format and opt out of tracking the total number of hits (track_total_hits) for performance reasons.Checklist
Delete any items that are not applicable to this PR.
For maintainers
Plugin API changes
When using the
datapluginsearchservicesearchmethod, you can now provide an additional argument,legacyHitsTotal, in theoptions. When set totrue(the default), thehits.totalwill be returned as a number. When set tofalse, thehits.totalformat will be returned as-is from the Elasticsearch response.Open questions
How do we want to expose this option to
esaggs?