ESQL: Hide spatial grid functions behind SNAPSHOT #129839

alex-spies · 2025-06-23T09:26:38Z

Only technically breaking on Serverless, where there should be no users of this feature as of yet.

#125143 added 9 spatial grid functions and released them into Serverless.
We think this is not the best long-term approach and the functions in #129581 are likely better.

Unfortunately, the latter PR has a wide blast radius and will require some time; so this PR only removes the spatial grid functions added in #125143 from release builds so they don't get released into 8.19/9.1.

elasticsearchmachine · 2025-06-23T09:27:02Z

Pinging @elastic/es-analytical-engine (Team:Analytics)

elasticsearchmachine · 2025-06-23T09:27:03Z

Hi @alex-spies, I've created a changelog YAML for you. Note that since this PR is labelled >breaking, you need to update the changelog YAML to fill out the extended information sections.

alex-spies · 2025-06-23T09:29:46Z

This doesn't yet touch the documentation for ST_GEOHASH, ST_GEOTILE and ST_GEOHEX - that needs to be pulled as well.

github-actions · 2025-06-23T09:32:18Z

🔍 Preview links for changed docs:

docs/reference/query-languages/esql/functions-operators/spatial-functions.md

🔔 The preview site may take up to 3 minutes to finish building. These links will become live once it completes.

alex-spies · 2025-06-23T09:39:03Z

@leemthompo , do you know if we need to do something special about the Kibana docs? We still emit the auto-generated docs for the SNAPSHOT-hidden functions, but this seems to be consistent with other SNAPSHOT-only functions like KNN?

leemthompo · 2025-06-23T09:47:55Z

I'm not sure how Kibana ignores snapshot stuff from inline docs, @stratoula will know

if they've been already generated and are now live on serverless, possibly will need to manually remove them

craigtaverner · 2025-06-23T09:51:43Z

I'm not sure how Kibana ignores snapshot stuff from inline docs, @stratoula will know

if they've been already generated and are now live on serverless, possibly will need to manually remove them

Kibana regenerates their content weekly from what we publish. So if we make a change in this PR, it will take up to a week to get into Kibana. They can run it manually earlier if necessary.

craigtaverner · 2025-06-23T09:53:27Z

I see the kibana files are not updated:

st_geohash.json:  "snapshot_only" : false

I can push a change for that.

stratoula · 2025-06-23T09:54:46Z

Craig is right, this runs every Monday (EMEA morning) but if you want me to run it earlier please let me know 👍

You have to update the kibana docs and definitions though otherwise the script won't get the changes

docs/changelog/129839.yaml

This doesn't apply to stateful at all.

…search into snapshot-geogrid-fcts

leemthompo

Docs changes LGTM

elasticsearchmachine · 2025-06-23T15:17:48Z

💔 Backport failed

Status	Branch	Result
❌	8.19	Commit could not be cherrypicked due to conflicts

You can use sqren/backport to manually backport by running backport --upstream elastic/elasticsearch --pr 129839

alex-spies · 2025-06-23T15:26:44Z

💚 All backports created successfully

Status	Branch	Result
✅	8.19

Questions ?

Please refer to the Backport tool documentation

elastic#125143 added 9 spatial grid functions and released them into Serverless. We think this is not the best long-term approach and the functions in elastic#129581 are likely better. As a first step, rmove the spatial grid functions added in elastic#125143 from release builds so they don't get released into 8.19/9.1. --------- Co-authored-by: Craig Taverner <[email protected]> (cherry picked from commit efb1397) # Conflicts: # docs/reference/query-languages/esql/_snippets/lists/spatial-functions.md # docs/reference/query-languages/esql/functions-operators/spatial-functions.md

#125143 added 9 spatial grid functions and released them into Serverless. We think this is not the best long-term approach and the functions in #129581 are likely better. As a first step, remove the spatial grid functions added in #125143 from release builds so they don't get released into 8.19/9.1. --------- Co-authored-by: Craig Taverner <[email protected]> (cherry picked from commit efb1397) # Conflicts: # docs/reference/query-languages/esql/_snippets/lists/spatial-functions.md # docs/reference/query-languages/esql/functions-operators/spatial-functions.md

…o` metadata (#128576) - Add PREVIEW annotations to all preview functions - Update docs generation logic to use annotations instead of preview boolean * Changed stack: ga 9.1 to stack: coming in multiple places - Match.java: Updated the options parameter description - MultiMatch.java: Updated the options parameter description - ToLower.java: Reformatted parameter description and updated version annotation - ToUpper.java: Removed the appliesTo annotation entirely and reformatted parameter description - updated applies_to annotations to specify both preview 9.0.0 and ga 9.1.0 lifecycle stages - added version-specific documentation examples with applies_to markers for ga 9.1.0 features - enhanced to_lower and to_upper functions to indicate support for multi-valued expressions in ga 9.1.0 - added version guards around function parameters and descriptions using applies_to syntax - updated function parameter descriptions to indicate ga 9.1.0 availability for named parameters - use detailedDescription + and fix match_phrase applies_to syntax - strip inline applies_to from kibana docs - update roundto, matchphrase lifecycles - fix match named params info - various spatial functions are preview - unsigned long is preview - update qstr - Update TO_LOWER/TO_UPPER parameter descriptions for clarity - hide spatial functions per #129839 - added `stack: ga 9.1.0` blocks to match_phrase.md and qstr.md examples - simplified term.md version from `preview 9.0.0` to just `preview` - added `applies_to = "stack: ga 9.1.0"` to matchphrase and querystring java annotations - removed version `9.0.0` from term function annotation - deleted unused `makeCallout()` and `appendLifeCycleAndVersion()` methods Co-authored-by: elasticsearchmachine <[email protected]> Co-authored-by: Liam Thompson <[email protected]> Co-authored-by: Liam Thompson <[email protected]> Co-authored-by: Nik Everett <[email protected]>

## Summary I had to run it manually due to this ES change elastic/elasticsearch#129839

elastic#125143 added 9 spatial grid functions and released them into Serverless. We think this is not the best long-term approach and the functions in elastic#129581 are likely better. As a first step, rmove the spatial grid functions added in elastic#125143 from release builds so they don't get released into 8.19/9.1. --------- Co-authored-by: Craig Taverner <[email protected]>

…o` metadata (elastic#128576) - Add PREVIEW annotations to all preview functions - Update docs generation logic to use annotations instead of preview boolean * Changed stack: ga 9.1 to stack: coming in multiple places - Match.java: Updated the options parameter description - MultiMatch.java: Updated the options parameter description - ToLower.java: Reformatted parameter description and updated version annotation - ToUpper.java: Removed the appliesTo annotation entirely and reformatted parameter description - updated applies_to annotations to specify both preview 9.0.0 and ga 9.1.0 lifecycle stages - added version-specific documentation examples with applies_to markers for ga 9.1.0 features - enhanced to_lower and to_upper functions to indicate support for multi-valued expressions in ga 9.1.0 - added version guards around function parameters and descriptions using applies_to syntax - updated function parameter descriptions to indicate ga 9.1.0 availability for named parameters - use detailedDescription + and fix match_phrase applies_to syntax - strip inline applies_to from kibana docs - update roundto, matchphrase lifecycles - fix match named params info - various spatial functions are preview - unsigned long is preview - update qstr - Update TO_LOWER/TO_UPPER parameter descriptions for clarity - hide spatial functions per elastic#129839 - added `stack: ga 9.1.0` blocks to match_phrase.md and qstr.md examples - simplified term.md version from `preview 9.0.0` to just `preview` - added `applies_to = "stack: ga 9.1.0"` to matchphrase and querystring java annotations - removed version `9.0.0` from term function annotation - deleted unused `makeCallout()` and `appendLifeCycleAndVersion()` methods Co-authored-by: elasticsearchmachine <[email protected]> Co-authored-by: Liam Thompson <[email protected]> Co-authored-by: Liam Thompson <[email protected]> Co-authored-by: Nik Everett <[email protected]>

## Summary I had to run it manually due to this ES change elastic/elasticsearch#129839

Hide spatial grid fcts behind SNAPSHOT

97b37d1

alex-spies requested a review from craigtaverner June 23, 2025 09:26

alex-spies added >breaking auto-backport Automatically create backport pull requests when merged :Analytics/ES|QL AKA ESQL v8.19.0 v9.1.0 labels Jun 23, 2025

elasticsearchmachine added the Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) label Jun 23, 2025

Update docs/changelog/129839.yaml

6dbd5e6

Remove documentation for the unreleased functions

a25439c

alex-spies requested a review from leemthompo June 23, 2025 09:38

leemthompo reviewed Jun 23, 2025

View reviewed changes

docs/changelog/129839.yaml Outdated Show resolved Hide resolved

alex-spies added the >non-issue label Jun 23, 2025

alex-spies and others added 4 commits June 23, 2025 11:57

Delete docs/changelog/129839.yaml

8b10d86

Remove obsolete changelog files

6f8a3de

This doesn't apply to stateful at all.

Update Kibana docs with snapshot_only:true

52be67f

Merge branch 'snapshot-geogrid-fcts' of github.com:alex-spies/elastic…

9c39a7d

…search into snapshot-geogrid-fcts

leemthompo approved these changes Jun 23, 2025

View reviewed changes

craigtaverner approved these changes Jun 23, 2025

View reviewed changes

Merge branch 'main' into snapshot-geogrid-fcts

01636c4

alex-spies merged commit efb1397 into elastic:main Jun 23, 2025
32 checks passed

elasticsearchmachine added the backport pending label Jun 23, 2025

leemthompo added a commit to craigtaverner/elasticsearch that referenced this pull request Jun 23, 2025

hide spatial functions per elastic#129839

712c67d

alex-spies mentioned this pull request Jun 23, 2025

[8.19] ESQL: Hide spatial grid functions behind SNAPSHOT (#129839) #129868

Merged

stratoula mentioned this pull request Jun 24, 2025

[ES|QL] Functions definitions updates elastic/kibana#224993

Merged

stratoula added a commit to elastic/kibana that referenced this pull request Jun 24, 2025

[ES|QL] Functions definitions updates (#224993)

0404a6d

## Summary I had to run it manually due to this ES change elastic/elasticsearch#129839

luigidellaquila mentioned this pull request Jun 25, 2025

ES|QL: fix telemetry tests after FORK release #129983

Merged

akowalska622 pushed a commit to akowalska622/kibana that referenced this pull request Jun 25, 2025

[ES|QL] Functions definitions updates (elastic#224993)

1d7fe13

## Summary I had to run it manually due to this ES change elastic/elasticsearch#129839

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

ESQL: Hide spatial grid functions behind SNAPSHOT #129839

ESQL: Hide spatial grid functions behind SNAPSHOT #129839

Uh oh!

alex-spies commented Jun 23, 2025

Uh oh!

elasticsearchmachine commented Jun 23, 2025

Uh oh!

elasticsearchmachine commented Jun 23, 2025

Uh oh!

alex-spies commented Jun 23, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jun 23, 2025 •

edited

Loading

Uh oh!

alex-spies commented Jun 23, 2025

Uh oh!

leemthompo commented Jun 23, 2025 •

edited

Loading

Uh oh!

craigtaverner commented Jun 23, 2025

Uh oh!

craigtaverner commented Jun 23, 2025

Uh oh!

stratoula commented Jun 23, 2025 •

edited

Loading

Uh oh!

Uh oh!

leemthompo left a comment

Uh oh!

Uh oh!

elasticsearchmachine commented Jun 23, 2025

Uh oh!

alex-spies commented Jun 23, 2025

Uh oh!

Uh oh!

ESQL: Hide spatial grid functions behind SNAPSHOT #129839

ESQL: Hide spatial grid functions behind SNAPSHOT #129839

Uh oh!

Conversation

alex-spies commented Jun 23, 2025

Uh oh!

elasticsearchmachine commented Jun 23, 2025

Uh oh!

elasticsearchmachine commented Jun 23, 2025

Uh oh!

alex-spies commented Jun 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jun 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alex-spies commented Jun 23, 2025

Uh oh!

leemthompo commented Jun 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

craigtaverner commented Jun 23, 2025

Uh oh!

craigtaverner commented Jun 23, 2025

Uh oh!

stratoula commented Jun 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

leemthompo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

elasticsearchmachine commented Jun 23, 2025

💔 Backport failed

Uh oh!

alex-spies commented Jun 23, 2025

💚 All backports created successfully

Questions ?

Uh oh!

Uh oh!

alex-spies commented Jun 23, 2025 •

edited

Loading

github-actions bot commented Jun 23, 2025 •

edited

Loading

leemthompo commented Jun 23, 2025 •

edited

Loading

stratoula commented Jun 23, 2025 •

edited

Loading