Fang Xing df1130f4b2 [ES|QL][DOCS] Add docs for date_period and time_duration (#116368) (#117021) há 10 meses atrás
..
appendix 735d80dffd ESQL: Add COUNT and COUNT_DISTINCT aggregation tests (#111409) há 1 ano atrás
description dae79b5c22 [8.x] [ESQL] Add support BYTE_LENGTH scalar function (#116591) (#116731) há 11 meses atrás
examples 33dfe554e7 ESQL: Docs: COUNT: add an explanation to the use of the 3VL (#116684) (#117006) há 10 meses atrás
kibana b3edb3a6a4 [ESQL] Update docs format (missing space before '=') (#116808) (#116816) há 11 meses atrás
layout dae79b5c22 [8.x] [ESQL] Add support BYTE_LENGTH scalar function (#116591) (#116731) há 11 meses atrás
parameters dae79b5c22 [8.x] [ESQL] Add support BYTE_LENGTH scalar function (#116591) (#116731) há 11 meses atrás
signature dae79b5c22 [8.x] [ESQL] Add support BYTE_LENGTH scalar function (#116591) (#116731) há 11 meses atrás
types dae79b5c22 [8.x] [ESQL] Add support BYTE_LENGTH scalar function (#116591) (#116731) há 11 meses atrás
README.md 96227a1970 ESQL: Generate kibana inline docs (#106782) há 1 ano atrás
aggregation-functions.asciidoc bc69827e1e ESQL: WEIGHTED_AVG aggregation tests and docs (#111449) há 1 ano atrás
binary.asciidoc df1130f4b2 [ES|QL][DOCS] Add docs for date_period and time_duration (#116368) (#117021) há 10 meses atrás
cast.asciidoc 7af45cc52e ESQL: Document the cast operator (::) (#107871) há 1 ano atrás
conditional-functions-and-expressions.asciidoc 11de886346 [ES|QL] Add/Modify annotations for spatial and conditional functions for better doc generation (#107722) há 1 ano atrás
date-time-functions.asciidoc fed808850d ES|QL: Add unit tests for now() function (#108498) há 1 ano atrás
grouping-functions.asciidoc a21242054b ESQL: Document BUCKET as a grouping function (#107864) há 1 ano atrás
in.asciidoc bc59315baa [DOCS] Examples for ES|QL DISSECT and WHERE (#102591) há 1 ano atrás
ip-functions.asciidoc fc0313f429 ESQL: Add aggregations testing base and docs (#110042) há 1 ano atrás
like.asciidoc 5290630bd0 ES|QL: improve docs about escaping for GROK, DISSECT, LIKE, RLIKE (#115320) (#115493) há 11 meses atrás
logical.asciidoc 8ac4ba751e Restructure ES|QL docs (#100806) há 2 anos atrás
math-functions.asciidoc 42aa343daf [ES|QL] Add hypot function (#114382) (#114658) há 1 ano atrás
mv-functions.asciidoc fc2760cfd4 ESQL: mv_median_absolute_deviation function (#112055) há 1 ano atrás
operators.asciidoc b26d7d3e14 Introduce an IP functions group (#108304) há 1 ano atrás
predicates.asciidoc bc59315baa [DOCS] Examples for ES|QL DISSECT and WHERE (#102591) há 1 ano atrás
rlike.asciidoc 5290630bd0 ES|QL: improve docs about escaping for GROK, DISSECT, LIKE, RLIKE (#115320) (#115493) há 11 meses atrás
search-functions.asciidoc 78fc557d3f ES|QL Add full-text search to the functions docs page (#116024) há 11 meses atrás
spatial-functions.asciidoc 536d614694 ES|QL ST_DISTANCE Function (#108764) há 1 ano atrás
string-functions.asciidoc dae79b5c22 [8.x] [ESQL] Add support BYTE_LENGTH scalar function (#116591) (#116731) há 11 meses atrás
type-conversion-functions.asciidoc e8569356ea [ES|QL] explicit cast a string literal to date_period and time_duration in arithmetic operations (#109193) há 1 ano atrás
unary.asciidoc 3b738905e1 ESQL: Add type tables for operators to docs (#103206) há 1 ano atrás

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