[DOCS][9.x] Update ESQL metadata fields page #129939
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
**esql-metadata-fields.md:** - restructured from bullet list to table format for metadata fields - added `_index_mode` and `_source` fields to available metadata - improved field descriptions (more detailed) - added "usage and limitations" section - reorganized examples into subsections with headers - added `_score` sorting example - added tip box linking to search documentation
moved tutorial link into tip box at top added cross-reference to search overview documentation minor text flow improvements and punctuation fixes
Contributor
|
🔍 Preview links for changed docs:
🔔 The preview site may take up to 3 minutes to finish building. These links will become live once it completes. |
elasticsearchmachine
added
needs:triage
leemthompo
added
>docs
Collaborator
|
Pinging @elastic/es-docs (Team:Docs) |
elasticsearchmachine
removed
the
needs:triage
Collaborator
|
Pinging @elastic/es-analytical-engine (Team:Analytics) |
bpintea
approved these changes
Jun 25, 2025
| - The `_source` field is not supported by functions | ||
| - Only the `FROM` command supports the `METADATA` directive | ||
| - Once enabled, metadata fields work like regular index fields | ||
| - Fields are dropped after aggregations unless used for grouping ([example](#metadata-fields-and-aggregations)) |
Contributor
There was a problem hiding this comment.
Nit: this is true, but this is not metadata fields-specific.
| | [`_id`](/reference/elasticsearch/mapping-reference/mapping-id-field.md) | [keyword](/reference/elasticsearch/mapping-reference/keyword.md) | Unique document ID. | | ||
| | [`_ignored`](/reference/elasticsearch/mapping-reference/mapping-ignored-field.md) | [keyword](/reference/elasticsearch/mapping-reference/keyword.md) | Names every field in a document that was ignored when the document was indexed. | | ||
| | [`_index`](/reference/elasticsearch/mapping-reference/mapping-index-field.md) | [keyword](/reference/elasticsearch/mapping-reference/keyword.md) | Index name. | | ||
| | `_index_mode` | [keyword](/reference/elasticsearch/mapping-reference/keyword.md) | [Index mode](/reference/elasticsearch/index-settings/index-modules.md#index-mode-setting). For example: `standard`, `lookup`, or `logsdb`. | |
leemthompo
commented
Jun 25, 2025
Co-authored-by: Bogdan Pintea <[email protected]>
Contributor
Author
|
thx @bpintea! |
mridula-s109
pushed a commit
to mridula-s109/elasticsearch
that referenced
this pull request
Jun 25, 2025
* [DOCS] Update ESQL metadata fields page **esql-metadata-fields.md:** - restructured from bullet list to table format for metadata fields - added `_index_mode` and `_source` fields to available metadata - improved field descriptions (more detailed) - added "usage and limitations" section - reorganized examples into subsections with headers - added `_score` sorting example - added tip box linking to search documentation * 🚙Drive by updates to search functions ref page moved tutorial link into tip box at top added cross-reference to search overview documentation minor text flow improvements and punctuation fixes * Fix id typo * Apply suggestions from review Co-authored-by: Bogdan Pintea <[email protected]>
leemthompo
changed the title
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.
Fixes #129905
esql-metadata-fields.md_index_modeand_sourcefields to available metadata_scoresorting exampleAlso made some drive by updates to search functions ref page in 3c13c68
See URL previews