首頁 探索 說明
註冊 登入
lqb
/
elasticsearch
镜像来自 https://gitee.com/mirrors/elasticsearch.git
1
0
複刻 0
檔案 問題管理 0 Wiki
目錄樹: de725aef80
分支列表 標籤列表
elasticsearch
/
docs
/
reference
/
esql
/
functions
Bogdan Pintea de725aef80 Add docs clarifications on DATE_DIFF args (#108301) 1 年之前
..
description de725aef80 Add docs clarifications on DATE_DIFF args (#108301) 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