Skip to content

docs: document ES|QL data source and fields browsers in Discover (#5701)#6082

Merged
florent-leborgne merged 10 commits intomainfrom
docs-issue-5701-esql-resource-browsers
Apr 27, 2026
Merged

docs: document ES|QL data source and fields browsers in Discover (#5701)#6082
florent-leborgne merged 10 commits intomainfrom
docs-issue-5701-esql-resource-browsers

Conversation

@florent-leborgne
Copy link
Copy Markdown
Member

@florent-leborgne florent-leborgne commented Apr 22, 2026

Summary

This PR addresses #5701 with the following changes:

  • explore-analyze/discover/try-esql.md: Adds a new H2 Browse indices and fields from the editor right after the get-started tutorial, scoped to stack: ga 9.4 / serverless: ga. Documents:

    • The data source browser, including the source types it surfaces (matching the UI filter labels: Alias, Index, Integration, Lookup Index, Stream, Timeseries), the TS-only filtering for time series sources, and the formatting-preserving insert behavior.
    • The fields browser, scoped to the data sources currently in the query, with single-field insertion at the cursor.
    • Both entry points: the autocomplete menu (Browse indices / Browse fields) and the clickable FROM/TS badge.
    • The main-query-only constraint (no subqueries).

    The section sits naturally next to the existing Discover-only editor sections (Create and edit lookup indices from queries, Add variable controls to your Discover queries).

  • explore-analyze/query-filter/languages/esql-kibana.md: Adds a single Discover-specific sentence at the end of Autocomplete and in-app help cross-linking to the new section in try-esql.md. The detailed content lives on the Discover page since the feature is Discover-only for now.

Resolves

Closes #5701


AI-generated draft — created with Claude Opus 4.7.
Review all generated content for factual accuracy before merging.

Adds a "Browse data sources and fields" section to the ES|QL Kibana
overview describing the Browse indices/Browse fields autocomplete
entries and the FROM/TS badge. Adds a tagged tip in the Discover ES|QL
tutorial pointing to the new browsers.

Made-with: Cursor
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 22, 2026

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 22, 2026

Vale Linting Results

Summary: 1 warning found

⚠️ Warnings (1)
File Line Rule Message
explore-analyze/discover/try-esql.md 108 Elastic.Spelling 'subqueries' is a possible misspelling.

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.

The data source and fields browsers are Discover-only. Keep the broader
ES|QL editor page (esql-kibana.md) light with a one-line cross-reference,
and document the feature in detail on try-esql.md as a new H2 placed
right after the get-started tutorial.

Made-with: Cursor
@florent-leborgne
Copy link
Copy Markdown
Member Author

It appears that this feature should remain Discover-specific for the time being - reshuffling to better locate the information

Comment thread explore-analyze/discover/try-esql.md Outdated
Comment thread explore-analyze/discover/try-esql.md Outdated
Co-authored-by: Florent LB <florent.leborgne@elastic.co>
@florent-leborgne
Copy link
Copy Markdown
Member Author

  • I could test and confirm that this also works nicely with CPS;
  • ES|QL views look to not be listed there for now and only available through the autocomplete, but I'll double-confirm that when working on my ES|QL views-related issue.

@florent-leborgne florent-leborgne marked this pull request as ready for review April 24, 2026 10:20
@florent-leborgne florent-leborgne requested review from a team as code owners April 24, 2026 10:20
Copy link
Copy Markdown
Contributor

@stratoula stratoula left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! 👌


When you write a query, the {{esql}} editor includes two interactive browsers that help you find available data sources and field names:

- **Data source browser**: lists the data sources of the following types that you can query: **Alias**, **Index**, **Integration**, **Lookup Index**, **Stream**, and **Timeseries**. Selections are inserted into the `FROM` or `TS` command and existing sources stay preserved. When the query starts with `TS`, only time series data sources are listed.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there's a nascent external data sources project afoot in ES|QL which might result in a confusing naming collision here

wonder if we could use different terminologies here, something like this maybe:

  • Index type browser: lists the indices and data stream types available to query:

Otherwise, "index abstractions" is the internal umbrella term we're using for these

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah we've been chatting about this in some internal threads with @stratoula and some more folks. We didn't land on any decision but I think we at least had a common opinion that data source is the right name there, it can be external at some point, sure.

It doesn't make much sense to try to use some synonyms that will end up confusing users more than having clear terminology with well defined nouns and clear qualifiers/adjectives for identifying the differences.

Kind of what we failed to do with serverless projects and hosted deployments and to this day we're still struggling with it :D

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't disagree 👍

Copy link
Copy Markdown
Member

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🍏

@florent-leborgne florent-leborgne enabled auto-merge (squash) April 27, 2026 13:16
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 27, 2026

Elastic Docs AI PR menu

Check the box to run an AI review for this pull request.

Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team.

@florent-leborgne florent-leborgne merged commit 000d803 into main Apr 27, 2026
11 checks passed
@florent-leborgne florent-leborgne deleted the docs-issue-5701-esql-resource-browsers branch April 27, 2026 13:18
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs review summary

Focus areas

  • Style and clarity: Two minor issues — awkward phrasing ("stay preserved") and empty link text. Both have inline suggestions.
  • Jargon: No Elastic-internal jargon found in the changed sections.
  • Frontmatter and applies_to: Page-level frontmatter is intact on both files. The new section in try-esql.md uses a correct fenced {applies_to} block after the heading. The inline {applies_to} tags in esql-kibana.md are appropriate for paragraph-level scoping.
  • Content type fit: The new section is a focused how-to reference block, well-placed alongside existing Discover-only editor sections. The cross-link from esql-kibana.md is appropriately minimal.
  • Parent issue satisfaction: Closes #5701. The PR documents both the data source browser and the fields browser, both entry points (autocomplete menu and FROM/TS badge), and the main-query-only constraint. The issue appears fully satisfied.

Nits

  • try-esql.md line 108: Vale flagged subqueries as a possible misspelling. It is standard SQL terminology and likely a false positive, but the CI comment is already tracking it.

Docs automation | From workflow: Docs review agent

React with 👍 if helpful, 👎 if not.


![The ES|QL syntax reference and the autocomplete menu](/explore-analyze/images/kibana-esql-in-app-help.png "")

{applies_to}`stack: ga 9.4` {applies_to}`serverless: ga` In **Discover**, the editor also includes interactive browsers for selecting data sources and field names from the autocomplete menu. Refer to [](/explore-analyze/discover/try-esql.md#discover-esql-resource-browsers) for details.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The empty link text [](...) is an accessibility issue — screen readers will announce the raw URL or file path instead of meaningful text.

Suggest explicit link text:

Suggested change
{applies_to}`stack: ga 9.4` {applies_to}`serverless: ga` In **Discover**, the editor also includes interactive browsers for selecting data sources and field names from the autocomplete menu. Refer to [](/explore-analyze/discover/try-esql.md#discover-esql-resource-browsers) for details.
{applies_to}`stack: ga 9.4` {applies_to}`serverless: ga` In **Discover**, the editor also includes interactive browsers for selecting data sources and field names from the autocomplete menu. Refer to [Browse indices and fields from the editor](/explore-analyze/discover/try-esql.md#discover-esql-resource-browsers) for details.


When you write a query, the {{esql}} editor includes two interactive browsers that help you find available data sources and field names:

- **Data source browser**: lists the data sources of the following types that you can query: **Alias**, **Index**, **Integration**, **Lookup Index**, **Stream**, and **Timeseries**. Selections are inserted into the `FROM` or `TS` command and existing sources stay preserved. When the query starts with `TS`, only time series data sources are listed.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"existing sources stay preserved" is awkward phrasing — "stay" is redundant alongside "preserved".

Suggested change
- **Data source browser**: lists the data sources of the following types that you can query: **Alias**, **Index**, **Integration**, **Lookup Index**, **Stream**, and **Timeseries**. Selections are inserted into the `FROM` or `TS` command and existing sources stay preserved. When the query starts with `TS`, only time series data sources are listed.
- **Data source browser**: lists the data sources of the following types that you can query: **Alias**, **Index**, **Integration**, **Lookup Index**, **Stream**, and **Timeseries**. Selections are inserted into the `FROM` or `TS` command and existing sources are preserved. When the query starts with `TS`, only time series data sources are listed.

florent-leborgne added a commit that referenced this pull request Apr 30, 2026
#6188)

## Summary

Follow-up to #6082, which addressed parent issue #5701 but didn't
explicitly close the two sibling issues #6068 and #6072. This PR adds
the two behavioral details from #6072 that weren't covered:

- the data source browser supports **multi-select** (add/remove several
sources in one session)
- sources already present in the query appear **pre-selected**

These are the only details from #6068 and #6072 worth documenting; other
behaviors (replace/deselect for the fields browser, no-preselection,
formatting-preserving inserts) are either self-evident from the UI or
already implied by the existing wording.

## Resolves

Closes #6068
Closes #6072

Made with [Cursor](https://cursor.com)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Browse and insert data sources and fields directly from the ES|QL editor in Discover

3 participants