صفحهٔ اصلی گشت‌و‌گذار راهنما
ثبت نام ورود
lqb
/
elasticsearch
mirrorاز https://gitee.com/mirrors/elasticsearch.git
1
0
انشعاب 0
پرونده‌ها مشکلات 0 ویکی
درخت: 5290630bd0
شاخه‌ها تگ‌ها
elasticsearch
/
docs
/
reference
/
esql
/
functions
Luigi Dell'Aquila 5290630bd0 ES|QL: improve docs about escaping for GROK, DISSECT, LIKE, RLIKE (#115320) (#115493) 11 ماه پیش
..
appendix 735d80dffd ESQL: Add COUNT and COUNT_DISTINCT aggregation tests (#111409) 1 سال پیش
description f38f2301bc ESQL: Skip unsupported grapheme cluster test (#115258) 11 ماه پیش
examples 14c1c3c1cc [8.x] Add ESQL match function (#113374) (#114695) 1 سال پیش
kibana 5290630bd0 ES|QL: improve docs about escaping for GROK, DISSECT, LIKE, RLIKE (#115320) (#115493) 11 ماه پیش
layout 14c1c3c1cc [8.x] Add ESQL match function (#113374) (#114695) 1 سال پیش
parameters 14c1c3c1cc [8.x] Add ESQL match function (#113374) (#114695) 1 سال پیش
signature 14c1c3c1cc [8.x] Add ESQL match function (#113374) (#114695) 1 سال پیش
types 14c1c3c1cc [8.x] Add ESQL match function (#113374) (#114695) 1 سال پیش
README.md 96227a1970 ESQL: Generate kibana inline docs (#106782) 1 سال پیش
aggregation-functions.asciidoc bc69827e1e ESQL: WEIGHTED_AVG aggregation tests and docs (#111449) 1 سال پیش
binary.asciidoc 6fbc52d170 ESQL docs: Push down needs index and doc_values (#110353) 1 سال پیش
cast.asciidoc 7af45cc52e ESQL: Document the cast operator (::) (#107871) 1 سال پیش
conditional-functions-and-expressions.asciidoc 11de886346 [ES|QL] Add/Modify annotations for spatial and conditional functions for better doc generation (#107722) 1 سال پیش
date-time-functions.asciidoc fed808850d ES|QL: Add unit tests for now() function (#108498) 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 fc0313f429 ESQL: Add aggregations testing base and docs (#110042) 1 سال پیش
like.asciidoc 5290630bd0 ES|QL: improve docs about escaping for GROK, DISSECT, LIKE, RLIKE (#115320) (#115493) 11 ماه پیش
logical.asciidoc 8ac4ba751e Restructure ES|QL docs (#100806) 2 سال پیش
math-functions.asciidoc 42aa343daf [ES|QL] Add hypot function (#114382) (#114658) 1 سال پیش
mv-functions.asciidoc fc2760cfd4 ESQL: mv_median_absolute_deviation function (#112055) 1 سال پیش
operators.asciidoc b26d7d3e14 Introduce an IP functions group (#108304) 1 سال پیش
predicates.asciidoc bc59315baa [DOCS] Examples for ES|QL DISSECT and WHERE (#102591) 1 سال پیش
rlike.asciidoc 5290630bd0 ES|QL: improve docs about escaping for GROK, DISSECT, LIKE, RLIKE (#115320) (#115493) 11 ماه پیش
spatial-functions.asciidoc 536d614694 ES|QL ST_DISTANCE Function (#108764) 1 سال پیش
string-functions.asciidoc 2046b497fc [ES|QL] add reverse function (#113297) (#114163) 1 سال پیش
type-conversion-functions.asciidoc e8569356ea [ES|QL] explicit cast a string literal to date_period and time_duration in arithmetic operations (#109193) 1 سال پیش
unary.asciidoc 3b738905e1 ESQL: Add type tables for operators to docs (#103206) 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