Skip to content

[DOCS][ESQL] Update additional docs for CPS#144300

Open
leemthompo wants to merge 13 commits intoelastic:mainfrom
leemthompo:cps-esql-docs-updates
Open

[DOCS][ESQL] Update additional docs for CPS#144300
leemthompo wants to merge 13 commits intoelastic:mainfrom
leemthompo:cps-esql-docs-updates

Conversation

@leemthompo
Copy link
Copy Markdown
Member

@leemthompo leemthompo commented Mar 16, 2026

Follow up to #144206

Summary

New file:

project_routing.md — documents the project_routing SET parameter (serverless preview)
Updated files:

toc.md — includes project_routing.md
esql-cross-clusters.md — top note pointing serverless users to the CPS page; new H2 "Query across serverless projects" at the bottom with a link
esql-multi.md — added "Query across serverless projects" as a third bullet (serverless: preview)
esql-lookup-join.md — added CPS note alongside the Cross-cluster support section
esql-enrich-data.md — added note that ENRICH is not supported in CPS
esql-multi-index.md — added note pointing serverless users to CPS for qualified index expression syntax
from.md — tagged existing "Query remote clusters" as stack-only; added a parallel serverless entry for CPS
enrich.md — added a note under mode parameter that it doesn't apply in CPS

🤖

Claude Code helped

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 16, 2026

@github-actions
Copy link
Copy Markdown
Contributor

ℹ️ Important: Docs version tagging

👋 Thanks for updating the docs! Just a friendly reminder that our docs are now cumulative. This means all 9.x versions are documented on the same page and published off of the main branch, instead of creating separate pages for each minor version.

We use applies_to tags to mark version-specific features and changes.

Expand for a quick overview

When to use applies_to tags:

✅ At the page level to indicate which products/deployments the content applies to (mandatory)
✅ When features change state (e.g. preview, ga) in a specific version
✅ When availability differs across deployments and environments

What NOT to do:

❌ Don't remove or replace information that applies to an older version
❌ Don't add new information that applies to a specific version without an applies_to tag
❌ Don't forget that applies_to tags can be used at the page, section, and inline level

🤔 Need help?

You can use `ENRICH` with remote clusters. For detailed information about cross-cluster enrichment syntax and configuration, refer to [ENRICH across clusters](/reference/query-languages/esql/esql-cross-clusters.md#ccq-enrich).

::::{note}
`ENRICH` is not supported in [cross-project search (CPS)](/reference/query-languages/esql/esql-cross-serverless-projects.md), because enrich policies are not available in {{serverless-short}}.
Copy link
Copy Markdown
Contributor

@quux00 quux00 Mar 17, 2026

Choose a reason for hiding this comment

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

because enrich policies are not available in {{serverless-short}}.

Is this correct? I haven't heard that before, and based on this https://www.elastic.co/docs/api/doc/elasticsearch-serverless/operation/operation-enrich-get-policy that seems wrong?

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.

Discussed with @idegtiarenko. He thinks that ENRICH with ES|QL does work in serverless. He will add tests to confirm. If that's right and once that's done, we should remove this statement

Copy link
Copy Markdown
Member Author

@leemthompo leemthompo Mar 23, 2026

Choose a reason for hiding this comment

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

  • removing provisionally and the removing unavailable tag at top of page

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.

@leemthompo leemthompo added >docs General docs changes Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) labels Mar 23, 2026
@leemthompo leemthompo marked this pull request as ready for review March 23, 2026 11:48
@leemthompo leemthompo requested a review from a team as a code owner March 23, 2026 11:48
@elasticsearchmachine elasticsearchmachine added needs:triage Requires assignment of a team area label and removed Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) labels Mar 23, 2026
@leemthompo leemthompo added Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) Team:Docs Meta label for docs team and removed needs:triage Requires assignment of a team area label labels Mar 24, 2026
@elasticsearchmachine elasticsearchmachine removed the Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) label Mar 24, 2026
@elasticsearchmachine
Copy link
Copy Markdown
Collaborator

Pinging @elastic/core-docs (Team:Docs)

Copy link
Copy Markdown
Member

@luigidellaquila luigidellaquila left a comment

Choose a reason for hiding this comment

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

Thanks @leemthompo, I had a quick look and there is at least one thing that needs to be fixed, see below

@@ -0,0 +1,22 @@
### `project_routing` [esql-project_routing]
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.

This is supposed to be a generated file.
We excluded it manually waiting for project_routing to become public, see https://github.com/elastic/elasticsearch/blob/main/x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/plan/QuerySettingsTests.java#L260-L280

The correct way to do this is to update the definition here https://github.com/elastic/elasticsearch/blob/main/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/plan/QuerySettings.java#L36 and re-run ProjectSettingsTests (after the manual override is removed)

If you want, I can take care of it, just let me know

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.

@luigidellaquila ah ok cool thanks, yeah if you don't mind taking care of that, that would be great

we'll have to wait until CPS goes live to merge that :)

Copy link
Copy Markdown
Contributor

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

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

hello, looks lovely. here are some thoughts and feelings

```


In {{serverless-short}}, queries using an unqualified `<target>` automatically run across all linked projects with [cross-project search (CPS)](esql-cross-serverless-projects.md). Use `<project-alias>:<target>` to restrict the query to a specific project. {applies_to}`serverless: preview`
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.

⚠️ if you're using es|ql within a space, then the space-level setting will restrict the projects your query will run against. it's also limited by the access of the user or key doing the querying. might want to link to this file when it makes sense to do so https://github.com/elastic/docs-content/pull/5498/files#diff-bf6a818a867ec4c2a275fbc52d0bebadbc6bf225fcfc4a876cc0cbda35323e2f

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.

also might want to be clearer that in stack you have to specify your indices always

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.

hopefully addressed by 7afa15a

with TODO for that final linkeroo

- enrich.md: remove incorrect note that mode param doesn't apply in CPS
- from.md: state default behavior (all projects) in CPS section
- esql-cross-clusters.md: make serverless note more explicit
- esql-lookup-join.md: promote CPS to sibling section (not nested under cross-cluster)
- esql-multi.md: merge upstream subquery addition; add projects to intro
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

>docs General docs changes Team:Docs Meta label for docs team v9.4.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants