|
10 сар өмнө | |
---|---|---|
.. | ||
appendix | 735d80dffd ESQL: Add COUNT and COUNT_DISTINCT aggregation tests (#111409) | 1 жил өмнө |
description | 5b220ddc88 ES|QL categorize docs (#117827) (#117838) | 10 сар өмнө |
examples | 5b220ddc88 ES|QL categorize docs (#117827) (#117838) | 10 сар өмнө |
kibana | 5b220ddc88 ES|QL categorize docs (#117827) (#117838) | 10 сар өмнө |
layout | 5b220ddc88 ES|QL categorize docs (#117827) (#117838) | 10 сар өмнө |
parameters | 891d3e53f9 [8.x] ES|QL kql function. (#116764) (#117474) | 10 сар өмнө |
signature | 891d3e53f9 [8.x] ES|QL kql function. (#116764) (#117474) | 10 сар өмнө |
types | d90b4c7a9a Backport 9022ccc (#117699) | 10 сар өмнө |
README.md | 96227a1970 ESQL: Generate kibana inline docs (#106782) | 1 жил өмнө |
aggregation-functions.asciidoc | 04849b0fd8 [ES|QL] Add a standard deviation function (#116531) (#117398) | 10 сар өмнө |
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 | 5b220ddc88 ES|QL categorize docs (#117827) (#117838) | 10 сар өмнө |
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 | 20e02fab75 ESQL: Add docs for MV_PERCENTILE (#117377) (#117381) | 10 сар өмнө |
operators.asciidoc | 5a9c05ea1d ESQL - match operator included in non-snapshot builds (#116819) (#117224) | 10 сар өмнө |
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 | 78fc557d3f ES|QL Add full-text search to the functions docs page (#116024) | 11 сар өмнө |
search.asciidoc | 5a9c05ea1d ESQL - match operator included in non-snapshot builds (#116819) (#117224) | 10 сар өмнө |
spatial-functions.asciidoc | 5b21640b33 Make spatial search functions not preview (#117489) (#117498) | 10 сар өмнө |
string-functions.asciidoc | dae79b5c22 [8.x] [ESQL] Add support BYTE_LENGTH scalar function (#116591) (#116731) | 11 сар өмнө |
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 жил өмнө |
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 functiontypes
- a table of each combination of support type for each parameter. These are generated from tests.layout
- a fully generated description for each functionkibana/definition
- function definitions for kibana's ESQL editorkibana/docs
- the inline docs for kibanaMost 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