elastic · elasticsearchmachine · Apr 9, 2024 · Mar 26, 2024 · Mar 26, 2024 · Mar 29, 2024
diff --git a/docs/reference/esql/functions/README.md b/docs/reference/esql/functions/README.md
@@ -5,6 +5,7 @@ The files in these subdirectories are generated by ESQL's test suite:
 * `signature` - railroad diagram of the syntax to invoke each function
 * `types` - a table of each combination of support type for each parameter. These are generated from tests.
 * `layout` - a fully generated description for each function
+* `kibana` - the inline docs for kibana
 
 Most functions can use the generated docs generated in the `layout` directory.
 If we need something more custom for the function we can make a file in this

diff --git a/docs/reference/esql/functions/kibana/abs.md b/docs/reference/esql/functions/kibana/abs.md
@@ -0,0 +1,11 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### ABS
+Returns the absolute value.
+
+```
+ROW number = -1.0 
+| EVAL abs_number = ABS(number)
+```
diff --git a/docs/reference/esql/functions/kibana/acos.md b/docs/reference/esql/functions/kibana/acos.md
@@ -0,0 +1,11 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### ACOS
+Returns the {wikipedia}/Inverse_trigonometric_functions[arccosine] of `n` as an angle, expressed in radians.
+
+```
+ROW a=.9
+| EVAL acos=ACOS(a)
+```
diff --git a/docs/reference/esql/functions/kibana/asin.md b/docs/reference/esql/functions/kibana/asin.md
@@ -0,0 +1,12 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### ASIN
+Returns the {wikipedia}/Inverse_trigonometric_functions[arcsine] of the input
+numeric expression as an angle, expressed in radians.
+
+```
+ROW a=.9
+| EVAL asin=ASIN(a)
+```
diff --git a/docs/reference/esql/functions/kibana/atan.md b/docs/reference/esql/functions/kibana/atan.md
@@ -0,0 +1,12 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### ATAN
+Returns the {wikipedia}/Inverse_trigonometric_functions[arctangent] of the input
+numeric expression as an angle, expressed in radians.
+
+```
+ROW a=12.9
+| EVAL atan=ATAN(a)
+```
diff --git a/docs/reference/esql/functions/kibana/atan2.md b/docs/reference/esql/functions/kibana/atan2.md
@@ -0,0 +1,12 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### ATAN2
+The {wikipedia}/Atan2[angle] between the positive x-axis and the ray from the
+origin to the point (x , y) in the Cartesian plane, expressed in radians.
+
+```
+ROW y=12.9, x=.6
+| EVAL atan2=ATAN2(y, x)
+```
diff --git a/docs/reference/esql/functions/kibana/auto_bucket.md b/docs/reference/esql/functions/kibana/auto_bucket.md
@@ -0,0 +1,8 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### AUTO_BUCKET
+Creates human-friendly buckets and returns a datetime value
+for each row that corresponds to the resulting bucket the row falls into.
+
diff --git a/docs/reference/esql/functions/kibana/case.md b/docs/reference/esql/functions/kibana/case.md
@@ -0,0 +1,8 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### CASE
+Accepts pairs of conditions and values.
+The function returns the value that belongs to the first condition that evaluates to true.
+
diff --git a/docs/reference/esql/functions/kibana/ceil.md b/docs/reference/esql/functions/kibana/ceil.md
@@ -0,0 +1,12 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### CEIL
+Round a number up to the nearest integer.
+
+```
+ROW a=1.8
+| EVAL a=CEIL(a)
+```
+Note: This is a noop for `long` (including unsigned) and `integer`. For `double` this picks the closest `double` value to the integer similar to {javadoc}/java.base/java/lang/Math.html#ceil(double)[Math.ceil].
diff --git a/docs/reference/esql/functions/kibana/coalesce.md b/docs/reference/esql/functions/kibana/coalesce.md
@@ -0,0 +1,11 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### COALESCE
+Returns the first of its arguments that is not null. If all arguments are null, it returns `null`.
+
+```
+ROW a=null, b="b"
+| EVAL COALESCE(a, b)
+```
diff --git a/docs/reference/esql/functions/kibana/concat.md b/docs/reference/esql/functions/kibana/concat.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### CONCAT
+Concatenates two or more strings.
+
diff --git a/docs/reference/esql/functions/kibana/cos.md b/docs/reference/esql/functions/kibana/cos.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### COS
+Returns the trigonometric cosine of an angle
+
diff --git a/docs/reference/esql/functions/kibana/cosh.md b/docs/reference/esql/functions/kibana/cosh.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### COSH
+Returns the hyperbolic cosine of a number
+
diff --git a/docs/reference/esql/functions/kibana/date_diff.md b/docs/reference/esql/functions/kibana/date_diff.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### DATE_DIFF
+Subtract 2 dates and return their difference in multiples of a unit specified in the 1st argument
+
diff --git a/docs/reference/esql/functions/kibana/date_extract.md b/docs/reference/esql/functions/kibana/date_extract.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### DATE_EXTRACT
+Extracts parts of a date, like year, month, day, hour.
+
diff --git a/docs/reference/esql/functions/kibana/date_parse.md b/docs/reference/esql/functions/kibana/date_parse.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### DATE_PARSE
+Parses a string into a date value
+
diff --git a/docs/reference/esql/functions/kibana/e.md b/docs/reference/esql/functions/kibana/e.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### E
+Euler’s number.
+
diff --git a/docs/reference/esql/functions/kibana/ends_with.md b/docs/reference/esql/functions/kibana/ends_with.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### ENDS_WITH
+Returns a boolean that indicates whether a keyword string ends with another string
+
diff --git a/docs/reference/esql/functions/kibana/floor.md b/docs/reference/esql/functions/kibana/floor.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### FLOOR
+Round a number down to the nearest integer.
+
diff --git a/docs/reference/esql/functions/kibana/greatest.md b/docs/reference/esql/functions/kibana/greatest.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### GREATEST
+Returns the maximum value from many columns.
+
diff --git a/docs/reference/esql/functions/kibana/least.md b/docs/reference/esql/functions/kibana/least.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### LEAST
+Returns the minimum value from many columns.
+
diff --git a/docs/reference/esql/functions/kibana/left.md b/docs/reference/esql/functions/kibana/left.md
@@ -0,0 +1,14 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### LEFT
+Returns the substring that extracts 'length' chars from 'string' starting from the left.
+
+```
+FROM employees
+| KEEP last_name
+| EVAL left = LEFT(last_name, 3)
+| SORT last_name ASC
+| LIMIT 5
+```
diff --git a/docs/reference/esql/functions/kibana/length.md b/docs/reference/esql/functions/kibana/length.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### LENGTH
+Returns the character length of a string.
+
diff --git a/docs/reference/esql/functions/kibana/log.md b/docs/reference/esql/functions/kibana/log.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### LOG
+Returns the logarithm of a number to a base.
+
diff --git a/docs/reference/esql/functions/kibana/log10.md b/docs/reference/esql/functions/kibana/log10.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### LOG10
+Returns the log base 10.
+
diff --git a/docs/reference/esql/functions/kibana/ltrim.md b/docs/reference/esql/functions/kibana/ltrim.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### LTRIM
+Removes leading whitespaces from a string.
+
diff --git a/docs/reference/esql/functions/kibana/mv_avg.md b/docs/reference/esql/functions/kibana/mv_avg.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### MV_AVG
+Converts a multivalued field into a single valued field containing the average of all of the values.
+
diff --git a/docs/reference/esql/functions/kibana/mv_concat.md b/docs/reference/esql/functions/kibana/mv_concat.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### MV_CONCAT
+Reduce a multivalued string field to a single valued field by concatenating all values.
+
diff --git a/docs/reference/esql/functions/kibana/mv_count.md b/docs/reference/esql/functions/kibana/mv_count.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### MV_COUNT
+Reduce a multivalued field to a single valued field containing the count of values.
+
diff --git a/docs/reference/esql/functions/kibana/mv_dedupe.md b/docs/reference/esql/functions/kibana/mv_dedupe.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### MV_DEDUPE
+Remove duplicate values from a multivalued field.
+
diff --git a/docs/reference/esql/functions/kibana/mv_first.md b/docs/reference/esql/functions/kibana/mv_first.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### MV_FIRST
+Reduce a multivalued field to a single valued field containing the first value.
+
diff --git a/docs/reference/esql/functions/kibana/mv_last.md b/docs/reference/esql/functions/kibana/mv_last.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### MV_LAST
+Reduce a multivalued field to a single valued field containing the last value.
+
diff --git a/docs/reference/esql/functions/kibana/mv_max.md b/docs/reference/esql/functions/kibana/mv_max.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### MV_MAX
+Reduce a multivalued field to a single valued field containing the maximum value.
+
diff --git a/docs/reference/esql/functions/kibana/mv_median.md b/docs/reference/esql/functions/kibana/mv_median.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### MV_MEDIAN
+Converts a multivalued field into a single valued field containing the median value.
+
diff --git a/docs/reference/esql/functions/kibana/mv_min.md b/docs/reference/esql/functions/kibana/mv_min.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### MV_MIN
+Reduce a multivalued field to a single valued field containing the minimum value.
+
diff --git a/docs/reference/esql/functions/kibana/mv_slice.md b/docs/reference/esql/functions/kibana/mv_slice.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### MV_SLICE
+Returns a subset of the multivalued field using the start and end index values.
+
diff --git a/docs/reference/esql/functions/kibana/mv_sort.md b/docs/reference/esql/functions/kibana/mv_sort.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### MV_SORT
+Sorts a multivalued field in lexicographical order.
+
diff --git a/docs/reference/esql/functions/kibana/mv_sum.md b/docs/reference/esql/functions/kibana/mv_sum.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### MV_SUM
+Converts a multivalued field into a single valued field containing the sum of all of the values.
+
diff --git a/docs/reference/esql/functions/kibana/mv_zip.md b/docs/reference/esql/functions/kibana/mv_zip.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### MV_ZIP
+Combines the values from two multivalued fields with a delimiter that joins them together.
+
diff --git a/docs/reference/esql/functions/kibana/pi.md b/docs/reference/esql/functions/kibana/pi.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### PI
+The ratio of a circle’s circumference to its diameter.
+
diff --git a/docs/reference/esql/functions/kibana/pow.md b/docs/reference/esql/functions/kibana/pow.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### POW
+Returns the value of a base raised to the power of an exponent.
+
diff --git a/docs/reference/esql/functions/kibana/replace.md b/docs/reference/esql/functions/kibana/replace.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### REPLACE
+The function substitutes in the string any match of the regular expression with the replacement string.
+
diff --git a/docs/reference/esql/functions/kibana/right.md b/docs/reference/esql/functions/kibana/right.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### RIGHT
+Return the substring that extracts length chars from the string starting from the right.
+
diff --git a/docs/reference/esql/functions/kibana/round.md b/docs/reference/esql/functions/kibana/round.md
@@ -0,0 +1,7 @@
+<!--
+This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+-->
+
+### ROUND
+Rounds a number to the closest number with the specified number of digits.
+