Inicio Explorar Axuda
Rexistro Iniciar sesión
lqb
/
elasticsearch
réplica de https://gitee.com/mirrors/elasticsearch.git
1
0
Fork 0
Ficheiros Incidencias 0 Wiki
Árbore: 0acda3a659
Ramas Etiquetas
elasticsearch
/
docs
/
reference
/
esql
/
functions
Nik Everett 0acda3a659 ESQL: Add `documents_found` and `values_loaded` (#125631) (#130029) hai 3 meses
..
appendix 735d80dffd ESQL: Add COUNT and COUNT_DISTINCT aggregation tests (#111409) hai 1 ano
description 0acda3a659 ESQL: Add `documents_found` and `values_loaded` (#125631) (#130029) hai 3 meses
examples 0acda3a659 ESQL: Add `documents_found` and `values_loaded` (#125631) (#130029) hai 3 meses
functionNamedParams 0acda3a659 ESQL: Add `documents_found` and `values_loaded` (#125631) (#130029) hai 3 meses
kibana c19cc6ba92 [DOCS][8.19] Promote ESQL search functions to GA in the docs (#129897) hai 3 meses
layout 0acda3a659 ESQL: Add `documents_found` and `values_loaded` (#125631) (#130029) hai 3 meses
parameters 0acda3a659 ESQL: Add `documents_found` and `values_loaded` (#125631) (#130029) hai 3 meses
signature 0acda3a659 ESQL: Add `documents_found` and `values_loaded` (#125631) (#130029) hai 3 meses
types 0acda3a659 ESQL: Add `documents_found` and `values_loaded` (#125631) (#130029) hai 3 meses
README.md 96227a1970 ESQL: Generate kibana inline docs (#106782) hai 1 ano
aggregation-functions.asciidoc 905f9f4692 ESQL: Support ST_EXTENT_AGG (#117451) (#118829) hai 10 meses
binary.asciidoc df1130f4b2 [ES|QL][DOCS] Add docs for date_period and time_duration (#116368) (#117021) hai 10 meses
cast.asciidoc 7af45cc52e ESQL: Document the cast operator (::) (#107871) hai 1 ano
conditional-functions-and-expressions.asciidoc 11de886346 [ES|QL] Add/Modify annotations for spatial and conditional functions for better doc generation (#107722) hai 1 ano
date-time-functions.asciidoc fed808850d ES|QL: Add unit tests for now() function (#108498) hai 1 ano
grouping-functions.asciidoc 9477d092ef ES|QL categorize -> GA (#129703) hai 3 meses
in.asciidoc bc59315baa [DOCS] Examples for ES|QL DISSECT and WHERE (#102591) hai 1 ano
ip-functions.asciidoc fc0313f429 ESQL: Add aggregations testing base and docs (#110042) hai 1 ano
like.asciidoc 5ebf9da6cc ESQL: Backport docs for LIKE list (#130011) hai 3 meses
logical.asciidoc 8ac4ba751e Restructure ES|QL docs (#100806) %!s(int64=2) %!d(string=hai) anos
math-functions.asciidoc fb6bccee4b ESQL: ROUND_TO function (#128278) (#128397) hai 4 meses
mv-functions.asciidoc 20e02fab75 ESQL: Add docs for MV_PERCENTILE (#117377) (#117381) hai 10 meses
operators.asciidoc c19cc6ba92 [DOCS][8.19] Promote ESQL search functions to GA in the docs (#129897) hai 3 meses
predicates.asciidoc bc59315baa [DOCS] Examples for ES|QL DISSECT and WHERE (#102591) hai 1 ano
rlike.asciidoc 5290630bd0 ES|QL: improve docs about escaping for GROK, DISSECT, LIKE, RLIKE (#115320) (#115493) hai 11 meses
search-functions.asciidoc c19cc6ba92 [DOCS][8.19] Promote ESQL search functions to GA in the docs (#129897) hai 3 meses
search.asciidoc c19cc6ba92 [DOCS][8.19] Promote ESQL search functions to GA in the docs (#129897) hai 3 meses
spatial-functions.asciidoc 5a171808b2 ESQL: Hide spatial grid functions behind SNAPSHOT (#129839) (#129868) hai 3 meses
string-functions.asciidoc b398448848 Hash functions (#118938) (#119769) hai 9 meses
type-conversion-functions.asciidoc 5af15f42cd [8.x] ESQL - docs for to_date_nanos (#120124) (#120203) hai 8 meses
unary.asciidoc 3b738905e1 ESQL: Add type tables for operators to docs (#103206) hai 1 ano

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