Home Esplora Aiuto
Accedi
lqb
/
elasticsearch
mirror da https://gitee.com/mirrors/elasticsearch.git
1
0
Forka 0
File Problemi 0 Wiki
Albero (Tree): 9482673fbe
Rami (Branch) Tag
elasticsearch
/
docs
/
reference
/
esql
/
functions
Bogdan Pintea 9482673fbe Docs: move base64 functions under string functions (#107866) 1 anno fa
..
description ad15d50863 [ES|QL] more doc generation via annotations (#107541) 1 anno fa
examples ad15d50863 [ES|QL] more doc generation via annotations (#107541) 1 anno fa
kibana ad15d50863 [ES|QL] more doc generation via annotations (#107541) 1 anno fa
layout ad15d50863 [ES|QL] more doc generation via annotations (#107541) 1 anno fa
parameters ad15d50863 [ES|QL] more doc generation via annotations (#107541) 1 anno fa
signature 353abef214 [ES|QL] Base64 decoding and encoding functions (#107390) 1 anno fa
types ad15d50863 [ES|QL] more doc generation via annotations (#107541) 1 anno fa
README.md 96227a1970 ESQL: Generate kibana inline docs (#106782) 1 anno fa
aggregation-functions.asciidoc d915b964ba Rename ST_CENTROID to ST_CENTROID_AGG (#107226) 1 anno fa
avg.asciidoc 980bc500b0 [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) 1 anno fa
binary.asciidoc 1541da5e65 ESQL: Generate more docs (#106367) 1 anno fa
case.asciidoc 8e0d4e1846 [DOCS] Improve ES|QL functions reference for functions A-D (#103447) 1 anno fa
cidr_match.asciidoc 8e0d4e1846 [DOCS] Improve ES|QL functions reference for functions A-D (#103447) 1 anno fa
coalesce.asciidoc 1541da5e65 ESQL: Generate more docs (#106367) 1 anno fa
conditional-functions-and-expressions.asciidoc 931dcae41d Add improvements to the ES|QL docs (#101195) 2 anni fa
count-distinct.asciidoc 980bc500b0 [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) 1 anno fa
count.asciidoc 980bc500b0 [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) 1 anno fa
date-time-functions.asciidoc ad15d50863 [ES|QL] more doc generation via annotations (#107541) 1 anno fa
ends_with.asciidoc 1541da5e65 ESQL: Generate more docs (#106367) 1 anno fa
greatest.asciidoc 1541da5e65 ESQL: Generate more docs (#106367) 1 anno fa
in.asciidoc bc59315baa [DOCS] Examples for ES|QL DISSECT and WHERE (#102591) 1 anno fa
least.asciidoc 1541da5e65 ESQL: Generate more docs (#106367) 1 anno fa
like.asciidoc bc59315baa [DOCS] Examples for ES|QL DISSECT and WHERE (#102591) 1 anno fa
logical.asciidoc 8ac4ba751e Restructure ES|QL docs (#100806) 2 anni fa
math-functions.asciidoc ad15d50863 [ES|QL] more doc generation via annotations (#107541) 1 anno fa
max.asciidoc 980bc500b0 [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) 1 anno fa
median-absolute-deviation.asciidoc 980bc500b0 [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) 1 anno fa
median.asciidoc 980bc500b0 [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) 1 anno fa
min.asciidoc 980bc500b0 [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) 1 anno fa
mv-functions.asciidoc e6d1c90501 [ES|QL] Add mv_sort (#106095) 1 anno fa
mv_avg.asciidoc 1541da5e65 ESQL: Generate more docs (#106367) 1 anno fa
mv_concat.asciidoc 1541da5e65 ESQL: Generate more docs (#106367) 1 anno fa
mv_count.asciidoc 1541da5e65 ESQL: Generate more docs (#106367) 1 anno fa
mv_dedupe.asciidoc 1541da5e65 ESQL: Generate more docs (#106367) 1 anno fa
mv_first.asciidoc 1541da5e65 ESQL: Generate more docs (#106367) 1 anno fa
mv_last.asciidoc 1541da5e65 ESQL: Generate more docs (#106367) 1 anno fa
mv_max.asciidoc 1541da5e65 ESQL: Generate more docs (#106367) 1 anno fa
mv_median.asciidoc 1541da5e65 ESQL: Generate more docs (#106367) 1 anno fa
mv_min.asciidoc 1541da5e65 ESQL: Generate more docs (#106367) 1 anno fa
mv_slice.asciidoc 1541da5e65 ESQL: Generate more docs (#106367) 1 anno fa
mv_sort.asciidoc 1541da5e65 ESQL: Generate more docs (#106367) 1 anno fa
mv_sum.asciidoc 1541da5e65 ESQL: Generate more docs (#106367) 1 anno fa
mv_zip.asciidoc 1541da5e65 ESQL: Generate more docs (#106367) 1 anno fa
now.asciidoc e87c49cb4b [DOCS] Improve ES|QL functions reference for functions E-Z (#104623) 1 anno fa
operators.asciidoc 282f0f0a00 [ESQL] Remove is_nan, is_finite, and is_infinite (#104091) 1 anno fa
percentile.asciidoc 980bc500b0 [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) 1 anno fa
predicates.asciidoc bc59315baa [DOCS] Examples for ES|QL DISSECT and WHERE (#102591) 1 anno fa
rlike.asciidoc bc59315baa [DOCS] Examples for ES|QL DISSECT and WHERE (#102591) 1 anno fa
round.asciidoc 1541da5e65 ESQL: Generate more docs (#106367) 1 anno fa
spatial-functions.asciidoc a7b38394d9 ESQL: Support ST_DISJOINT (#107007) 1 anno fa
st_centroid_agg.asciidoc d915b964ba Rename ST_CENTROID to ST_CENTROID_AGG (#107226) 1 anno fa
st_contains.asciidoc a7b38394d9 ESQL: Support ST_DISJOINT (#107007) 1 anno fa
st_disjoint.asciidoc a7b38394d9 ESQL: Support ST_DISJOINT (#107007) 1 anno fa
st_intersects.asciidoc a7b38394d9 ESQL: Support ST_DISJOINT (#107007) 1 anno fa
st_within.asciidoc a7b38394d9 ESQL: Support ST_DISJOINT (#107007) 1 anno fa
st_x.asciidoc 2380492fac ESQL: Support ST_CONTAINS and ST_WITHIN (#106503) 1 anno fa
st_y.asciidoc 2380492fac ESQL: Support ST_CONTAINS and ST_WITHIN (#106503) 1 anno fa
starts_with.asciidoc 1541da5e65 ESQL: Generate more docs (#106367) 1 anno fa
string-functions.asciidoc 9482673fbe Docs: move base64 functions under string functions (#107866) 1 anno fa
sum.asciidoc 980bc500b0 [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) 1 anno fa
type-conversion-functions.asciidoc 9482673fbe Docs: move base64 functions under string functions (#107866) 1 anno fa
unary.asciidoc 3b738905e1 ESQL: Add type tables for operators to docs (#103206) 1 anno fa
values.asciidoc c74490c137 ESQL: Enable VALUES agg for datetime (#107016) 1 anno fa

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