Почетна Преглед Помоћ
Пријавите се
lqb
/
elasticsearch
огледало од https://gitee.com/mirrors/elasticsearch.git
1
0
Креирај огранак 0
Датотеке Дискусије 0 Вики
Дрво: b26d7d3e14
Гране Ознаке
elasticsearch
/
docs
/
reference
/
esql
/
functions
Bogdan Pintea b26d7d3e14 Introduce an IP functions group (#108304) пре 1 година
..
description 4daac77e3b [ES|QL] Add/Modify annotations for operators for better doc generation (#108220) пре 1 година
examples 4daac77e3b [ES|QL] Add/Modify annotations for operators for better doc generation (#108220) пре 1 година
kibana 4daac77e3b [ES|QL] Add/Modify annotations for operators for better doc generation (#108220) пре 1 година
layout 4daac77e3b [ES|QL] Add/Modify annotations for operators for better doc generation (#108220) пре 1 година
parameters 4daac77e3b [ES|QL] Add/Modify annotations for operators for better doc generation (#108220) пре 1 година
signature 4daac77e3b [ES|QL] Add/Modify annotations for operators for better doc generation (#108220) пре 1 година
types 4daac77e3b [ES|QL] Add/Modify annotations for operators for better doc generation (#108220) пре 1 година
README.md 96227a1970 ESQL: Generate kibana inline docs (#106782) пре 1 година
aggregation-functions.asciidoc a21242054b ESQL: Document BUCKET as a grouping function (#107864) пре 1 година
avg.asciidoc 980bc500b0 [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) пре 1 година
binary.asciidoc 1541da5e65 ESQL: Generate more docs (#106367) пре 1 година
case.asciidoc 8e0d4e1846 [DOCS] Improve ES|QL functions reference for functions A-D (#103447) пре 1 година
cast.asciidoc 7af45cc52e ESQL: Document the cast operator (::) (#107871) пре 1 година
coalesce.asciidoc 1541da5e65 ESQL: Generate more docs (#106367) пре 1 година
conditional-functions-and-expressions.asciidoc 931dcae41d Add improvements to the ES|QL docs (#101195) пре 2 година
count-distinct.asciidoc 980bc500b0 [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) пре 1 година
count.asciidoc 980bc500b0 [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) пре 1 година
date-time-functions.asciidoc a21242054b ESQL: Document BUCKET as a grouping function (#107864) пре 1 година
greatest.asciidoc 1541da5e65 ESQL: Generate more docs (#106367) пре 1 година
grouping-functions.asciidoc a21242054b ESQL: Document BUCKET as a grouping function (#107864) пре 1 година
in.asciidoc bc59315baa [DOCS] Examples for ES|QL DISSECT and WHERE (#102591) пре 1 година
ip-functions.asciidoc b26d7d3e14 Introduce an IP functions group (#108304) пре 1 година
least.asciidoc 1541da5e65 ESQL: Generate more docs (#106367) пре 1 година
like.asciidoc 4daac77e3b [ES|QL] Add/Modify annotations for operators for better doc generation (#108220) пре 1 година
logical.asciidoc 8ac4ba751e Restructure ES|QL docs (#100806) пре 2 година
math-functions.asciidoc ad15d50863 [ES|QL] more doc generation via annotations (#107541) пре 1 година
max.asciidoc 980bc500b0 [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) пре 1 година
median-absolute-deviation.asciidoc 980bc500b0 [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) пре 1 година
median.asciidoc 980bc500b0 [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) пре 1 година
min.asciidoc 980bc500b0 [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) пре 1 година
mv-functions.asciidoc 7ae08306a0 mv functions (#107839) пре 1 година
now.asciidoc e87c49cb4b [DOCS] Improve ES|QL functions reference for functions E-Z (#104623) пре 1 година
operators.asciidoc b26d7d3e14 Introduce an IP functions group (#108304) пре 1 година
percentile.asciidoc 980bc500b0 [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) пре 1 година
predicates.asciidoc bc59315baa [DOCS] Examples for ES|QL DISSECT and WHERE (#102591) пре 1 година
rlike.asciidoc 4daac77e3b [ES|QL] Add/Modify annotations for operators for better doc generation (#108220) пре 1 година
round.asciidoc 1541da5e65 ESQL: Generate more docs (#106367) пре 1 година
spatial-functions.asciidoc a7b38394d9 ESQL: Support ST_DISJOINT (#107007) пре 1 година
st_centroid_agg.asciidoc d915b964ba Rename ST_CENTROID to ST_CENTROID_AGG (#107226) пре 1 година
st_contains.asciidoc a7b38394d9 ESQL: Support ST_DISJOINT (#107007) пре 1 година
st_disjoint.asciidoc a7b38394d9 ESQL: Support ST_DISJOINT (#107007) пре 1 година
st_intersects.asciidoc a7b38394d9 ESQL: Support ST_DISJOINT (#107007) пре 1 година
st_within.asciidoc a7b38394d9 ESQL: Support ST_DISJOINT (#107007) пре 1 година
st_x.asciidoc 2380492fac ESQL: Support ST_CONTAINS and ST_WITHIN (#106503) пре 1 година
st_y.asciidoc 2380492fac ESQL: Support ST_CONTAINS and ST_WITHIN (#106503) пре 1 година
string-functions.asciidoc 4daac77e3b [ES|QL] Add/Modify annotations for operators for better doc generation (#108220) пре 1 година
sum.asciidoc 980bc500b0 [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) пре 1 година
type-conversion-functions.asciidoc 9482673fbe Docs: move base64 functions under string functions (#107866) пре 1 година
unary.asciidoc 3b738905e1 ESQL: Add type tables for operators to docs (#103206) пре 1 година
values.asciidoc c74490c137 ESQL: Enable VALUES agg for datetime (#107016) пре 1 година

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