Startsida Utforska Hjälp
Logga in
lqb
/
elasticsearch
spegling av https://gitee.com/mirrors/elasticsearch.git
1
0
Fork 0
Filer Ärenden 0 Wiki
Träd: ceb9deff89
Grenar Taggar
elasticsearch
/
docs
/
reference
/
esql
/
functions
Fang Xing e8569356ea [ES|QL] explicit cast a string literal to date_period and time_duration in arithmetic operations (#109193) 1 år sedan
..
appendix 735d80dffd ESQL: Add COUNT and COUNT_DISTINCT aggregation tests (#111409) 1 år sedan
description e8569356ea [ES|QL] explicit cast a string literal to date_period and time_duration in arithmetic operations (#109193) 1 år sedan
examples e8569356ea [ES|QL] explicit cast a string literal to date_period and time_duration in arithmetic operations (#109193) 1 år sedan
kibana e8569356ea [ES|QL] explicit cast a string literal to date_period and time_duration in arithmetic operations (#109193) 1 år sedan
layout e8569356ea [ES|QL] explicit cast a string literal to date_period and time_duration in arithmetic operations (#109193) 1 år sedan
parameters e8569356ea [ES|QL] explicit cast a string literal to date_period and time_duration in arithmetic operations (#109193) 1 år sedan
signature e8569356ea [ES|QL] explicit cast a string literal to date_period and time_duration in arithmetic operations (#109193) 1 år sedan
types e8569356ea [ES|QL] explicit cast a string literal to date_period and time_duration in arithmetic operations (#109193) 1 år sedan
README.md 96227a1970 ESQL: Generate kibana inline docs (#106782) 1 år sedan
aggregation-functions.asciidoc bc69827e1e ESQL: WEIGHTED_AVG aggregation tests and docs (#111449) 1 år sedan
binary.asciidoc 6fbc52d170 ESQL docs: Push down needs index and doc_values (#110353) 1 år sedan
cast.asciidoc 7af45cc52e ESQL: Document the cast operator (::) (#107871) 1 år sedan
conditional-functions-and-expressions.asciidoc 11de886346 [ES|QL] Add/Modify annotations for spatial and conditional functions for better doc generation (#107722) 1 år sedan
date-time-functions.asciidoc fed808850d ES|QL: Add unit tests for now() function (#108498) 1 år sedan
grouping-functions.asciidoc a21242054b ESQL: Document BUCKET as a grouping function (#107864) 1 år sedan
in.asciidoc bc59315baa [DOCS] Examples for ES|QL DISSECT and WHERE (#102591) 1 år sedan
ip-functions.asciidoc fc0313f429 ESQL: Add aggregations testing base and docs (#110042) 1 år sedan
like.asciidoc 4daac77e3b [ES|QL] Add/Modify annotations for operators for better doc generation (#108220) 1 år sedan
logical.asciidoc 8ac4ba751e Restructure ES|QL docs (#100806) 2 år sedan
math-functions.asciidoc 453b82706d Add the EXP ES|QL function (#110879) 1 år sedan
mv-functions.asciidoc fc2760cfd4 ESQL: mv_median_absolute_deviation function (#112055) 1 år sedan
operators.asciidoc b26d7d3e14 Introduce an IP functions group (#108304) 1 år sedan
predicates.asciidoc bc59315baa [DOCS] Examples for ES|QL DISSECT and WHERE (#102591) 1 år sedan
rlike.asciidoc 4daac77e3b [ES|QL] Add/Modify annotations for operators for better doc generation (#108220) 1 år sedan
spatial-functions.asciidoc 536d614694 ES|QL ST_DISTANCE Function (#108764) 1 år sedan
string-functions.asciidoc fbaeb1ee61 [ESQL] Add `SPACE` function (#112350) 1 år sedan
type-conversion-functions.asciidoc e8569356ea [ES|QL] explicit cast a string literal to date_period and time_duration in arithmetic operations (#109193) 1 år sedan
unary.asciidoc 3b738905e1 ESQL: Add type tables for operators to docs (#103206) 1 år sedan

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