Nik Everett 2e22e73cdf ESQL: Remove date_nanos from generated docs (#111884) há 1 ano atrás
..
appendix 735d80dffd ESQL: Add COUNT and COUNT_DISTINCT aggregation tests (#111409) há 1 ano atrás
description f79c62157d ESQL: Add `MV_PSERIES_WEIGHTED_SUM` for score calculations used by security solution (#109017) há 1 ano atrás
examples f79c62157d ESQL: Add `MV_PSERIES_WEIGHTED_SUM` for score calculations used by security solution (#109017) há 1 ano atrás
kibana 2e22e73cdf ESQL: Remove date_nanos from generated docs (#111884) há 1 ano atrás
layout f79c62157d ESQL: Add `MV_PSERIES_WEIGHTED_SUM` for score calculations used by security solution (#109017) há 1 ano atrás
parameters f79c62157d ESQL: Add `MV_PSERIES_WEIGHTED_SUM` for score calculations used by security solution (#109017) há 1 ano atrás
signature f79c62157d ESQL: Add `MV_PSERIES_WEIGHTED_SUM` for score calculations used by security solution (#109017) há 1 ano atrás
types 2e22e73cdf ESQL: Remove date_nanos from generated docs (#111884) há 1 ano 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 6fbc52d170 ESQL docs: Push down needs index and doc_values (#110353) há 1 ano 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 4daac77e3b [ES|QL] Add/Modify annotations for operators for better doc generation (#108220) há 1 ano atrás
logical.asciidoc 8ac4ba751e Restructure ES|QL docs (#100806) há 2 anos atrás
math-functions.asciidoc 453b82706d Add the EXP ES|QL function (#110879) há 1 ano atrás
mv-functions.asciidoc f79c62157d ESQL: Add `MV_PSERIES_WEIGHTED_SUM` for score calculations used by security solution (#109017) 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 4daac77e3b [ES|QL] Add/Modify annotations for operators for better doc generation (#108220) há 1 ano atrás
spatial-functions.asciidoc 536d614694 ES|QL ST_DISTANCE Function (#108764) há 1 ano atrás
string-functions.asciidoc bb3ff8e924 ESQL: add REPEAT string function (#109220) há 1 ano atrás
type-conversion-functions.asciidoc 172c05918c [DOCS] ES|QL implicit casting (#108618) 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