mirror of https://github.com/elastic/elasticsearch.git synced 2025-06-29 01:44:36 -04:00

[DOCS] Update ES|QL generated docs to consistently use the applies_to 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 https://github.com/elastic/elasticsearch/pull/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 <infra-root+elasticsearchmachine@elastic.co>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
Co-authored-by: Nik Everett <nik9000@gmail.com>

2025-06-23 20:07:41 +02:00

1 KiB

Raw Permalink Blame History

navigation_title

mapped_pages

Spatial functions

https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-functions-operators.html#esql-spatial-functions

{{esql}} spatial functions [esql-spatial-functions]

{{esql}} supports these spatial functions:

:::{include} ../_snippets/lists/spatial-functions.md :::

:::{include} ../_snippets/functions/layout/st_distance.md :::

:::{include} ../_snippets/functions/layout/st_intersects.md :::

:::{include} ../_snippets/functions/layout/st_disjoint.md :::

:::{include} ../_snippets/functions/layout/st_contains.md :::

:::{include} ../_snippets/functions/layout/st_within.md :::

:::{include} ../_snippets/functions/layout/st_x.md :::

:::{include} ../_snippets/functions/layout/st_y.md :::

:::{include} ../_snippets/functions/layout/st_envelope.md :::

:::{include} ../_snippets/functions/layout/st_xmax.md :::

:::{include} ../_snippets/functions/layout/st_xmin.md :::

:::{include} ../_snippets/functions/layout/st_ymax.md :::

:::{include} ../_snippets/functions/layout/st_ymin.md :::

1 KiB Raw Permalink Blame History

{{esql}} spatial functions [esql-spatial-functions]

1 KiB

Raw Permalink Blame History