Home Explore Help
Register Sign In
lqb
/
elasticsearch
mirror of https://gitee.com/mirrors/elasticsearch.git
1
0
Fork 0
Files Issues 0 Wiki
Tree: 2ad83fbea2
Branches Tags
elasticsearch
/
docs
/
reference
/
esql
/
functions
Carlos Delgado 4dbed7e220 ES|QL: Add default values for match function options (#125282) (#125405) 6 months ago
..
appendix 735d80dffd ESQL: Add COUNT and COUNT_DISTINCT aggregation tests (#111409) 1 year ago
description e7d1a76eea Revert "[8.x] [ES|QL] ToAggregateMetricDouble function (elastic#124595) (#125172)" (#125277) 6 months ago
examples b39edb37a0 ESQL - Add Match function options (#120360) (#120992) 8 months ago
functionNamedParams 4dbed7e220 ES|QL: Add default values for match function options (#125282) (#125405) 6 months ago
kibana 4dbed7e220 ES|QL: Add default values for match function options (#125282) (#125405) 6 months ago
layout e7d1a76eea Revert "[8.x] [ES|QL] ToAggregateMetricDouble function (elastic#124595) (#125172)" (#125277) 6 months ago
parameters e7d1a76eea Revert "[8.x] [ES|QL] ToAggregateMetricDouble function (elastic#124595) (#125172)" (#125277) 6 months ago
signature e7d1a76eea Revert "[8.x] [ES|QL] ToAggregateMetricDouble function (elastic#124595) (#125172)" (#125277) 6 months ago
types e7d1a76eea Revert "[8.x] [ES|QL] ToAggregateMetricDouble function (elastic#124595) (#125172)" (#125277) 6 months ago
README.md 96227a1970 ESQL: Generate kibana inline docs (#106782) 1 year ago
aggregation-functions.asciidoc 905f9f4692 ESQL: Support ST_EXTENT_AGG (#117451) (#118829) 9 months ago
binary.asciidoc df1130f4b2 [ES|QL][DOCS] Add docs for date_period and time_duration (#116368) (#117021) 10 months ago
cast.asciidoc 7af45cc52e ESQL: Document the cast operator (::) (#107871) 1 year ago
conditional-functions-and-expressions.asciidoc 11de886346 [ES|QL] Add/Modify annotations for spatial and conditional functions for better doc generation (#107722) 1 year ago
date-time-functions.asciidoc fed808850d ES|QL: Add unit tests for now() function (#108498) 1 year ago
grouping-functions.asciidoc 5b220ddc88 ES|QL categorize docs (#117827) (#117838) 10 months ago
in.asciidoc bc59315baa [DOCS] Examples for ES|QL DISSECT and WHERE (#102591) 1 year ago
ip-functions.asciidoc fc0313f429 ESQL: Add aggregations testing base and docs (#110042) 1 year ago
like.asciidoc 5290630bd0 ES|QL: improve docs about escaping for GROK, DISSECT, LIKE, RLIKE (#115320) (#115493) 11 months ago
logical.asciidoc 8ac4ba751e Restructure ES|QL docs (#100806) 2 years ago
math-functions.asciidoc 42aa343daf [ES|QL] Add hypot function (#114382) (#114658) 1 year ago
mv-functions.asciidoc 20e02fab75 ESQL: Add docs for MV_PERCENTILE (#117377) (#117381) 10 months ago
operators.asciidoc 5a9c05ea1d ESQL - match operator included in non-snapshot builds (#116819) (#117224) 10 months ago
predicates.asciidoc bc59315baa [DOCS] Examples for ES|QL DISSECT and WHERE (#102591) 1 year ago
rlike.asciidoc 5290630bd0 ES|QL: improve docs about escaping for GROK, DISSECT, LIKE, RLIKE (#115320) (#115493) 11 months ago
search-functions.asciidoc 2daacef577 [8.x] [ES|QL] Enable KQL function as a tech preview (#119730) (#119954) 9 months ago
search.asciidoc 4b86fda751 Match, Like and RLike operators improved docs (#120504) (#120769) 8 months ago
spatial-functions.asciidoc d6c14a2b8a [8.x] Support ST_ENVELOPE and related ST_XMIN, etc. (#116964) (#118743) 9 months ago
string-functions.asciidoc b398448848 Hash functions (#118938) (#119769) 9 months ago
type-conversion-functions.asciidoc 5af15f42cd [8.x] ESQL - docs for to_date_nanos (#120124) (#120203) 8 months ago
unary.asciidoc 3b738905e1 ESQL: Add type tables for operators to docs (#103206) 1 year ago

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