Browse Source

Introduce an IP functions group (#108304)

This takes the CIDR_MATCH out of the operators group and adds it to a
new `IP functions` group.
The change also re-aranges the groups, grouping together the
type-specific functions and ordering them alphabetically.
Bogdan Pintea 1 year ago
parent
commit
b26d7d3e14

+ 24 - 13
docs/reference/esql/esql-functions-operators.asciidoc

@@ -22,22 +22,30 @@ include::functions/aggregation-functions.asciidoc[tag=agg_list]
 include::functions/grouping-functions.asciidoc[tag=group_list]
 ====
 
-.*Math functions*
+.*Conditional functions and expressions*
 [%collapsible]
 ====
-include::functions/math-functions.asciidoc[tag=math_list]
+include::functions/conditional-functions-and-expressions.asciidoc[tag=cond_list]
 ====
 
-.*String functions*
+// <Type-specific functions alphabetically ordered>
+
+.*Date and time functions*
 [%collapsible]
 ====
-include::functions/string-functions.asciidoc[tag=string_list]
+include::functions/date-time-functions.asciidoc[tag=date_list]
 ====
 
-.*Date and time functions*
+.*IP functions*
 [%collapsible]
 ====
-include::functions/date-time-functions.asciidoc[tag=date_list]
+include::functions/ip-functions.asciidoc[tag=ip_list]
+====
+
+.*Math functions*
+[%collapsible]
+====
+include::functions/math-functions.asciidoc[tag=math_list]
 ====
 
 .*Spatial functions*
@@ -46,16 +54,18 @@ include::functions/date-time-functions.asciidoc[tag=date_list]
 include::functions/spatial-functions.asciidoc[tag=spatial_list]
 ====
 
-.*Type conversion functions*
+.*String functions*
 [%collapsible]
 ====
-include::functions/type-conversion-functions.asciidoc[tag=type_list]
+include::functions/string-functions.asciidoc[tag=string_list]
 ====
 
-.*Conditional functions and expressions*
+// </Type-specific functions alphabetically ordered>
+
+.*Type conversion functions*
 [%collapsible]
 ====
-include::functions/conditional-functions-and-expressions.asciidoc[tag=cond_list]
+include::functions/type-conversion-functions.asciidoc[tag=type_list]
 ====
 
 .*Multi value functions*
@@ -75,11 +85,12 @@ include::functions/operators.asciidoc[tag=op_list]
 
 include::functions/aggregation-functions.asciidoc[]
 include::functions/grouping-functions.asciidoc[]
-include::functions/math-functions.asciidoc[]
-include::functions/string-functions.asciidoc[]
+include::functions/conditional-functions-and-expressions.asciidoc[]
 include::functions/date-time-functions.asciidoc[]
+include::functions/ip-functions.asciidoc[]
+include::functions/math-functions.asciidoc[]
 include::functions/spatial-functions.asciidoc[]
+include::functions/string-functions.asciidoc[]
 include::functions/type-conversion-functions.asciidoc[]
-include::functions/conditional-functions-and-expressions.asciidoc[]
 include::functions/mv-functions.asciidoc[]
 include::functions/operators.asciidoc[]

+ 14 - 0
docs/reference/esql/functions/ip-functions.asciidoc

@@ -0,0 +1,14 @@
+[[esql-ip-functions]]
+==== {esql} IP functions
+
+++++
+<titleabbrev>IP functions</titleabbrev>
+++++
+
+{esql} supports these IP functions:
+
+// tag::ip_list[]
+* <<esql-cidr_match>>
+// end::ip_list[]
+
+include::layout/cidr_match.asciidoc[]

+ 0 - 2
docs/reference/esql/functions/operators.asciidoc

@@ -13,7 +13,6 @@ Boolean operators for comparing against one or multiple expressions.
 * <<esql-logical-operators>>
 * <<esql-predicates>>
 * <<esql-cast-operator>>
-* <<esql-cidr_match>>
 * <<esql-in-operator>>
 * <<esql-like-operator>>
 * <<esql-rlike-operator>>
@@ -24,7 +23,6 @@ include::unary.asciidoc[]
 include::logical.asciidoc[]
 include::predicates.asciidoc[]
 include::cast.asciidoc[]
-include::layout/cidr_match.asciidoc[]
 include::in.asciidoc[]
 include::like.asciidoc[]
 include::rlike.asciidoc[]