Adds disclaimer on field_caps include_empty_fields flag when set to false
#106861
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
piergm
added
>docs
|
Documentation preview: |
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/es-search (Team:Search) |
javanna
reviewed
Mar 28, 2024
| @@ -78,7 +78,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailab | |||
| Defaults to `false`. | |||
|
|
|||
| `include_empty_fields`:: | |||
| (Optional, Boolean) If `false`, fields that never had a value in any shards are not included in the response. Fields that are not empty are always included. This flag does not consider deletions and updates. If a field was non-empty and all the documents containing that field were deleted or the field was removed by updates, it will still be returned even if the flag is `false`. | |||
| (Optional, Boolean) If `false`, fields that never had a value in any shards are not included in the response. Fields that are not empty are always included. This flag does not consider deletions and updates. If a field was non-empty and all the documents containing that field were deleted or the field was removed by updates, it will still be returned even if the flag is `false`. To be used with caution, if set to `false` it gives accurate results at the cost of longer response times compared to the default behavior. | |||
There was a problem hiding this comment.
Could you expand on what the factor is that causes longer response times, so users have the knowledge to decide and adequately test?
I wonder if we should have a warning flag like we do in other cases, that makes it more evident compared to a note in the text.
javanna
added
:Search Foundations/Search
elasticsearchmachine
added
Team:Search Foundations
|
Pinging @elastic/es-search-foundations (Team:Search Foundations) |
|
Important Elastic documentation is migrating to Markdown for version 9.0+. See the migration guide for details. ℹ️ What's happening?
What do I need to do?For <=8.x docs:
For 9.0+ docs:Option 1:
Option 2:
💡 Need help?
|
|
@piergm we never got this in :) |
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.
No description provided.