mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-29 01:44:36 -04:00
62b372b4dc
- Added the cube root function to ESQL (`CBRT(x)`). Nearly identical to SQRT, but without the negative numbers exception - Added docs generation support for Windows end lines (CRLF), as within the examples, it was writing the "\r" without the "\n" (Which was being converted to "\\n"), and some other inconsistencies - Some updates to `package-info.java` documentation over how to create functions - Fixes https://github.com/elastic/elasticsearch/issues/108675 Functions issue: https://github.com/elastic/elasticsearch/issues/98545 |
||
|---|---|---|
| .. | ||
| description | ||
| examples | ||
| kibana | ||
| layout | ||
| parameters | ||
| signature | ||
| types | ||
| aggregation-functions.asciidoc | ||
| avg.asciidoc | ||
| binary.asciidoc | ||
| case.asciidoc | ||
| cast.asciidoc | ||
| conditional-functions-and-expressions.asciidoc | ||
| count-distinct.asciidoc | ||
| count.asciidoc | ||
| date-time-functions.asciidoc | ||
| grouping-functions.asciidoc | ||
| in.asciidoc | ||
| ip-functions.asciidoc | ||
| like.asciidoc | ||
| logical.asciidoc | ||
| math-functions.asciidoc | ||
| max.asciidoc | ||
| median-absolute-deviation.asciidoc | ||
| median.asciidoc | ||
| min.asciidoc | ||
| mv-functions.asciidoc | ||
| operators.asciidoc | ||
| percentile.asciidoc | ||
| predicates.asciidoc | ||
| README.md | ||
| rlike.asciidoc | ||
| round.asciidoc | ||
| spatial-functions.asciidoc | ||
| st_centroid_agg.asciidoc | ||
| string-functions.asciidoc | ||
| sum.asciidoc | ||
| type-conversion-functions.asciidoc | ||
| unary.asciidoc | ||
| values.asciidoc | ||
The files in these subdirectories are generated by ESQL's test suite:
description- description of each function scraped from@FunctionInfo#descriptionexamples- examples of each function scraped from@FunctionInfo#examplesparameters- description of each function's parameters scraped from@Paramsignature- railroad diagram of the syntax to invoke each functiontypes- a table of each combination of support type for each parameter. These are generated from tests.layout- a fully generated description for each functionkibana/definition- function definitions for kibana's ESQL editorkibana/docs- 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
directory that can include:: any parts of the files above.
To regenerate the files for a function run its tests using gradle:
./gradlew :x-pack:plugin:esql:test -Dtests.class='*SinTests'
To regenerate the files for all functions run all of ESQL's tests using gradle:
./gradlew :x-pack:plugin:esql:test