Document ES|QL SET directive: unmapped_fields and approximation settings#5455
Draft
florent-leborgne wants to merge 6 commits intomainfrom
Draft
Document ES|QL SET directive: unmapped_fields and approximation settings#5455florent-leborgne wants to merge 6 commits intomainfrom
florent-leborgne wants to merge 6 commits intomainfrom
Conversation
Add a new section about the SET query directive to the ES|QL in Kibana page, covering the unmapped_fields setting with its FAIL and NULLIFY values. References the ES|QL SET directive reference page for full syntax details. Made-with: Cursor
Contributor
Vale Linting ResultsSummary: 1 suggestion found 💡 Suggestions (1)
The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
Contributor
🔍 Preview links for changed docs |
Document the approximation setting with its boolean and map parameter forms, including num_rows and confidence_level parameters with suggested values. Made-with: Cursor
florent-leborgne
changed the title
Move the SET directive content from a nested H3 under "Write queries" to a standalone H2 section titled "Control query behavior with SET", placed between "Filter by time" and "Use variables and controls". This better reflects the conceptual parity with other top-level sections that control query behavior. Made-with: Cursor
The SET directive is in preview per the ES|QL reference docs and the unmapped_fields setting has preview: true in the Kibana codebase. Made-with: Cursor
Document the actual server-side defaults from the Elasticsearch codebase: 100K rows without grouping, 1M with grouping, rows minimum of 10000, confidence_level range 0.5-0.95. Also corrects the suggested confidence_level values (max is 0.95, not 0.99 as suggested in Kibana autocomplete). Made-with: Cursor
Made-with: Cursor
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
unmapped_fieldssetting with itsFAIL(default) andNULLIFYvalues, including practical use cases (failure stores, mixed-mapping indices).approximationsetting with its boolean and map parameter forms (num_rows,confidence_level), including suggested values from the editor's autocomplete.Closes #4963
Closes #4962
Availability check needed for
approximationIn the Kibana codebase, the
approximationsetting currently hassnapshotOnly: trueandignoreAsSuggestion: true. This means:We need to confirm with the ES|QL team whether
snapshotOnlywill be changed tofalsefor 9.4 GA. If not, the approximation section should be removed or tagged differently before merging.The
unmapped_fieldssetting hassnapshotOnly: falseandignoreAsSuggestion: false, so it's available in production and shown in autocomplete — no concerns there.Related Kibana PRs
Generative AI disclosure
Tool(s) and model(s) used: claude-4.6-opus-high in Cursor