1
0
Nik Everett 0acda3a659 ESQL: Add `documents_found` and `values_loaded` (#125631) (#130029) 3 сар өмнө
..
appendix 735d80dffd ESQL: Add COUNT and COUNT_DISTINCT aggregation tests (#111409) 1 жил өмнө
description 0acda3a659 ESQL: Add `documents_found` and `values_loaded` (#125631) (#130029) 3 сар өмнө
examples 0acda3a659 ESQL: Add `documents_found` and `values_loaded` (#125631) (#130029) 3 сар өмнө
functionNamedParams 0acda3a659 ESQL: Add `documents_found` and `values_loaded` (#125631) (#130029) 3 сар өмнө
kibana c19cc6ba92 [DOCS][8.19] Promote ESQL search functions to GA in the docs (#129897) 3 сар өмнө
layout 0acda3a659 ESQL: Add `documents_found` and `values_loaded` (#125631) (#130029) 3 сар өмнө
parameters 0acda3a659 ESQL: Add `documents_found` and `values_loaded` (#125631) (#130029) 3 сар өмнө
signature 0acda3a659 ESQL: Add `documents_found` and `values_loaded` (#125631) (#130029) 3 сар өмнө
types 0acda3a659 ESQL: Add `documents_found` and `values_loaded` (#125631) (#130029) 3 сар өмнө
README.md 96227a1970 ESQL: Generate kibana inline docs (#106782) 1 жил өмнө
aggregation-functions.asciidoc 905f9f4692 ESQL: Support ST_EXTENT_AGG (#117451) (#118829) 9 сар өмнө
binary.asciidoc df1130f4b2 [ES|QL][DOCS] Add docs for date_period and time_duration (#116368) (#117021) 10 сар өмнө
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 9477d092ef ES|QL categorize -> GA (#129703) 3 сар өмнө
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 5ebf9da6cc ESQL: Backport docs for LIKE list (#130011) 3 сар өмнө
logical.asciidoc 8ac4ba751e Restructure ES|QL docs (#100806) 2 жил өмнө
math-functions.asciidoc fb6bccee4b ESQL: ROUND_TO function (#128278) (#128397) 4 сар өмнө
mv-functions.asciidoc 20e02fab75 ESQL: Add docs for MV_PERCENTILE (#117377) (#117381) 10 сар өмнө
operators.asciidoc c19cc6ba92 [DOCS][8.19] Promote ESQL search functions to GA in the docs (#129897) 3 сар өмнө
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 сар өмнө
search-functions.asciidoc c19cc6ba92 [DOCS][8.19] Promote ESQL search functions to GA in the docs (#129897) 3 сар өмнө
search.asciidoc c19cc6ba92 [DOCS][8.19] Promote ESQL search functions to GA in the docs (#129897) 3 сар өмнө
spatial-functions.asciidoc 5a171808b2 ESQL: Hide spatial grid functions behind SNAPSHOT (#129839) (#129868) 3 сар өмнө
string-functions.asciidoc b398448848 Hash functions (#118938) (#119769) 9 сар өмнө
type-conversion-functions.asciidoc 5af15f42cd [8.x] ESQL - docs for to_date_nanos (#120124) (#120203) 8 сар өмнө
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