Skip to content

Commit ff82ace

Browse files
committed
Add depthOffset to geo grid functions
1 parent 39720ee commit ff82ace

18 files changed

+27
-18
lines changed

docs/reference/query-languages/esql/_snippets/functions/layout/st_geohash_to_geoshape.md

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/_snippets/functions/layout/st_geohash_to_long.md

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/_snippets/functions/layout/st_geohash_to_string.md

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/_snippets/functions/layout/st_geohex_to_geoshape.md

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/_snippets/functions/layout/st_geohex_to_long.md

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/_snippets/functions/layout/st_geohex_to_string.md

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/_snippets/functions/layout/st_geotile_to_geoshape.md

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/_snippets/functions/layout/st_geotile_to_long.md

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/_snippets/functions/layout/st_geotile_to_string.md

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohashToGeoShape.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@ public class StGeohashToGeoShape extends AbstractConvertFunction implements Eval
4848
description = """
4949
Converts an input value to a `geo_shape` value.
5050
The input values are expected to be the grid-ids of geohash grids, in either long or string format.""",
51-
examples = @Example(file = "spatial-grid", tag = "geohash_to_geoshape")
51+
examples = @Example(file = "spatial-grid", tag = "geohash_to_geoshape"),
52+
depthOffset = 1 // make it appear as a subsection of ST_GEOHASH
5253
)
5354
public StGeohashToGeoShape(
5455
Source source,

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohashToLong.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@ public class StGeohashToLong extends AbstractConvertFunction implements Evaluato
4444
@FunctionInfo(
4545
returnType = "long",
4646
description = "Converts an input value representing a geohash grid-ID in string format into a long.",
47-
examples = { @Example(file = "spatial-grid", tag = "geohash_to_long") }
47+
examples = { @Example(file = "spatial-grid", tag = "geohash_to_long") },
48+
depthOffset = 1 // make it appear as a subsection of ST_GEOHASH
4849
)
4950
public StGeohashToLong(
5051
Source source,

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohashToString.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@ public class StGeohashToString extends AbstractConvertFunction implements Evalua
4444
@FunctionInfo(
4545
returnType = "keyword",
4646
description = "Converts an input value representing a geohash grid-ID in long format into a string.",
47-
examples = { @Example(file = "spatial-grid", tag = "geohash_to_string") }
47+
examples = { @Example(file = "spatial-grid", tag = "geohash_to_string") },
48+
depthOffset = 1 // make it appear as a subsection of ST_GEOHASH
4849
)
4950
public StGeohashToString(
5051
Source source,

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohexToGeoShape.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,8 @@ public class StGeohexToGeoShape extends AbstractConvertFunction implements Evalu
5252
description = """
5353
Converts an input value to a `geo_shape` value.
5454
The input values are expected to be the grid-ids of H3 grids, in either long or string format.""",
55-
examples = @Example(file = "spatial-grid", tag = "geohex_to_geoshape")
55+
examples = @Example(file = "spatial-grid", tag = "geohex_to_geoshape"),
56+
depthOffset = 1 // make it appear as a subsection of ST_GEOHEX
5657
)
5758
public StGeohexToGeoShape(
5859
Source source,

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohexToLong.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@ public class StGeohexToLong extends AbstractConvertFunction implements Evaluator
4444
@FunctionInfo(
4545
returnType = "long",
4646
description = "Converts an input value representing a geohex grid-ID in string format into a long.",
47-
examples = { @Example(file = "spatial-grid", tag = "geohex_to_long") }
47+
examples = { @Example(file = "spatial-grid", tag = "geohex_to_long") },
48+
depthOffset = 1 // make it appear as a subsection of ST_GEOHEX
4849
)
4950
public StGeohexToLong(
5051
Source source,

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohexToString.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@ public class StGeohexToString extends AbstractConvertFunction implements Evaluat
4444
@FunctionInfo(
4545
returnType = "keyword",
4646
description = "Converts an input value representing a Geohex grid-ID in long format into a string.",
47-
examples = { @Example(file = "spatial-grid", tag = "geohex_to_string") }
47+
examples = { @Example(file = "spatial-grid", tag = "geohex_to_string") },
48+
depthOffset = 1 // make it appear as a subsection of ST_GEOHEX
4849
)
4950
public StGeohexToString(
5051
Source source,

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeotileToGeoShape.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,8 @@ public class StGeotileToGeoShape extends AbstractConvertFunction implements Eval
5151
description = """
5252
Converts an input value to a `geo_shape` value.
5353
The input values are expected to be the grid-ids of geotile grids, in either long or string format.""",
54-
examples = @Example(file = "spatial-grid", tag = "geotile_to_geoshape")
54+
examples = @Example(file = "spatial-grid", tag = "geotile_to_geoshape"),
55+
depthOffset = 1 // make it appear as a subsection of ST_GEOTILE
5556
)
5657
public StGeotileToGeoShape(
5758
Source source,

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeotileToLong.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@ public class StGeotileToLong extends AbstractConvertFunction implements Evaluato
4444
@FunctionInfo(
4545
returnType = "long",
4646
description = "Converts an input value representing a geotile grid-ID in string format into a long.",
47-
examples = { @Example(file = "spatial-grid", tag = "geotile_to_long") }
47+
examples = { @Example(file = "spatial-grid", tag = "geotile_to_long") },
48+
depthOffset = 1 // make it appear as a subsection of ST_GEOTILE
4849
)
4950
public StGeotileToLong(
5051
Source source,

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeotileToString.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@ public class StGeotileToString extends AbstractConvertFunction implements Evalua
4444
@FunctionInfo(
4545
returnType = "keyword",
4646
description = "Converts an input value representing a geotile grid-ID in long format into a string.",
47-
examples = { @Example(file = "spatial-grid", tag = "geotile_to_string") }
47+
examples = { @Example(file = "spatial-grid", tag = "geotile_to_string") },
48+
depthOffset = 1 // make it appear as a subsection of ST_GEOTILE
4849
)
4950
public StGeotileToString(
5051
Source source,

0 commit comments

Comments
 (0)