Home Explore Help
Sign In
lqb
/
elasticsearch
mirror of https://gitee.com/mirrors/elasticsearch.git
1
0
Fork 0
Files Issues 0 Wiki
Tree: 826d49448b
Branches Tags
elasticsearch
/
docs
/
reference
/
esql
/
functions
Iván Cea Fontenla 826d49448b ESQL: Added Median and MedianAbsoluteDeviation aggregations tests and kibana docs (#111231) 1 year ago
..
appendix 826d49448b ESQL: Added Median and MedianAbsoluteDeviation aggregations tests and kibana docs (#111231) 1 year ago
description 826d49448b ESQL: Added Median and MedianAbsoluteDeviation aggregations tests and kibana docs (#111231) 1 year ago
examples 826d49448b ESQL: Added Median and MedianAbsoluteDeviation aggregations tests and kibana docs (#111231) 1 year ago
kibana 826d49448b ESQL: Added Median and MedianAbsoluteDeviation aggregations tests and kibana docs (#111231) 1 year ago
layout 826d49448b ESQL: Added Median and MedianAbsoluteDeviation aggregations tests and kibana docs (#111231) 1 year ago
parameters 826d49448b ESQL: Added Median and MedianAbsoluteDeviation aggregations tests and kibana docs (#111231) 1 year ago
signature 826d49448b ESQL: Added Median and MedianAbsoluteDeviation aggregations tests and kibana docs (#111231) 1 year ago
types 826d49448b ESQL: Added Median and MedianAbsoluteDeviation aggregations tests and kibana docs (#111231) 1 year ago
README.md 96227a1970 ESQL: Generate kibana inline docs (#106782) 1 year ago
aggregation-functions.asciidoc 826d49448b ESQL: Added Median and MedianAbsoluteDeviation aggregations tests and kibana docs (#111231) 1 year ago
binary.asciidoc 6fbc52d170 ESQL docs: Push down needs index and doc_values (#110353) 1 year ago
cast.asciidoc 7af45cc52e ESQL: Document the cast operator (::) (#107871) 1 year ago
conditional-functions-and-expressions.asciidoc 11de886346 [ES|QL] Add/Modify annotations for spatial and conditional functions for better doc generation (#107722) 1 year ago
count-distinct.asciidoc 980bc500b0 [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) 1 year ago
count.asciidoc 9f001169c6 ESQL: Document the pattern to count TRUE (#110820) 1 year ago
date-time-functions.asciidoc fed808850d ES|QL: Add unit tests for now() function (#108498) 1 year ago
grouping-functions.asciidoc a21242054b ESQL: Document BUCKET as a grouping function (#107864) 1 year ago
in.asciidoc bc59315baa [DOCS] Examples for ES|QL DISSECT and WHERE (#102591) 1 year ago
ip-functions.asciidoc fc0313f429 ESQL: Add aggregations testing base and docs (#110042) 1 year ago
like.asciidoc 4daac77e3b [ES|QL] Add/Modify annotations for operators for better doc generation (#108220) 1 year ago
logical.asciidoc 8ac4ba751e Restructure ES|QL docs (#100806) 2 years ago
math-functions.asciidoc 453b82706d Add the EXP ES|QL function (#110879) 1 year ago
median-absolute-deviation.asciidoc 0e68117935 Added Percentile aggregation tests and Kibana docs (#111050) 1 year ago
mv-functions.asciidoc 47edae4fbd ES|QL: reduce memory footprint for MvAppendTests with shapes (#109517) 1 year ago
operators.asciidoc b26d7d3e14 Introduce an IP functions group (#108304) 1 year ago
predicates.asciidoc bc59315baa [DOCS] Examples for ES|QL DISSECT and WHERE (#102591) 1 year ago
rlike.asciidoc 4daac77e3b [ES|QL] Add/Modify annotations for operators for better doc generation (#108220) 1 year ago
spatial-functions.asciidoc 536d614694 ES|QL ST_DISTANCE Function (#108764) 1 year ago
st_centroid_agg.asciidoc d915b964ba Rename ST_CENTROID to ST_CENTROID_AGG (#107226) 1 year ago
string-functions.asciidoc bb3ff8e924 ESQL: add REPEAT string function (#109220) 1 year ago
type-conversion-functions.asciidoc 172c05918c [DOCS] ES|QL implicit casting (#108618) 1 year ago
unary.asciidoc 3b738905e1 ESQL: Add type tables for operators to docs (#103206) 1 year ago
values.asciidoc c74490c137 ESQL: Enable VALUES agg for datetime (#107016) 1 year ago
weighted-avg.asciidoc 8abc8857f2 [ES|QL] weighted_avg (#109993) 1 year ago

README.md

The files in these subdirectories are generated by ESQL's test suite:

  • description - description of each function scraped from @FunctionInfo#description
  • examples - examples of each function scraped from @FunctionInfo#examples
  • parameters - description of each function's parameters scraped from @Param
  • 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/definition - function definitions for kibana's ESQL editor
  • kibana/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