github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-06-29 01:44:36 -04:00
Code Issues Projects Releases Packages Wiki Activity
elasticsearch/docs/reference/esql/functions
History
Nik Everett 00b0c54a74
ESQL: Generate docs for the trig functions (#106891) 
This updates the in-code docs on the trig functions to line up with the
docs, removes the docs, and uses the now mostly identical generated
docs. This means we only need to document these functions in one place -
right next to the code.
2024-03-29 12:24:31 -04:00
..
description ESQL: Generate docs for the trig functions (#106891) 2024-03-29 12:24:31 -04:00
examples ESQL: Generate docs for the trig functions (#106891) 2024-03-29 12:24:31 -04:00
layout ESQL: Generate docs for the trig functions (#106891) 2024-03-29 12:24:31 -04:00
parameters ESQL: Generate docs for the trig functions (#106891) 2024-03-29 12:24:31 -04:00
signature ESQL: Generate docs for the trig functions (#106891) 2024-03-29 12:24:31 -04:00
types ESQL: Generate docs for the trig functions (#106891) 2024-03-29 12:24:31 -04:00
aggregation-functions.asciidoc ESQL: Values aggregation function (#106065) 2024-03-21 12:52:04 -04:00
auto_bucket.asciidoc ESQL: Mark a few features as experimental (#105263) 2024-02-07 17:28:13 -08:00
avg.asciidoc [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) 2024-01-30 19:29:12 +01:00
binary.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
case.asciidoc [DOCS] Improve ES|QL functions reference for functions A-D (#103447) 2023-12-19 15:59:02 +01:00
cidr_match.asciidoc [DOCS] Improve ES|QL functions reference for functions A-D (#103447) 2023-12-19 15:59:02 +01:00
coalesce.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
concat.asciidoc [DOCS] Improve ES|QL functions reference for functions A-D (#103447) 2023-12-19 15:59:02 +01:00
conditional-functions-and-expressions.asciidoc Add improvements to the ES|QL docs (#101195) 2023-10-23 07:45:42 -07:00
cosh.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
count-distinct.asciidoc [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) 2024-01-30 19:29:12 +01:00
count.asciidoc [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) 2024-01-30 19:29:12 +01:00
date-time-functions.asciidoc ESQL: Mark a few features as experimental (#105263) 2024-02-07 17:28:13 -08:00
date_diff.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
date_extract.asciidoc [DOCS] Improve ES|QL functions reference for functions A-D (#103447) 2023-12-19 15:59:02 +01:00
date_format.asciidoc [DOCS] Improve ES|QL functions reference for functions A-D (#103447) 2023-12-19 15:59:02 +01:00
date_parse.asciidoc [DOCS] Small ES|QL improvements (#101877) 2023-11-07 17:24:59 +01:00
date_trunc.asciidoc [DOCS] Improve ES|QL functions reference for functions A-D (#103447) 2023-12-19 15:59:02 +01:00
e.asciidoc [DOCS] Improve ES|QL functions reference for functions E-Z (#104623) 2024-01-25 16:32:24 +01:00
ends_with.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
floor.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
greatest.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
in.asciidoc [DOCS] Examples for ES|QL DISSECT and WHERE (#102591) 2023-11-27 10:56:48 +01:00
least.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
length.asciidoc [DOCS] Improve ES|QL functions reference for functions E-Z (#104623) 2024-01-25 16:32:24 +01:00
like.asciidoc [DOCS] Examples for ES|QL DISSECT and WHERE (#102591) 2023-11-27 10:56:48 +01:00
log.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
log10.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
logical.asciidoc Restructure ES|QL docs (#100806) 2023-10-17 17:36:14 +02:00
ltrim.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
math-functions.asciidoc ESQL: Generate docs for the trig functions (#106891) 2024-03-29 12:24:31 -04:00
max.asciidoc [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) 2024-01-30 19:29:12 +01:00
median-absolute-deviation.asciidoc [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) 2024-01-30 19:29:12 +01:00
median.asciidoc [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) 2024-01-30 19:29:12 +01:00
min.asciidoc [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) 2024-01-30 19:29:12 +01:00
mv-functions.asciidoc [ES|QL] Add mv_sort (#106095) 2024-03-13 12:04:12 -04:00
mv_avg.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
mv_concat.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
mv_count.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
mv_dedupe.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
mv_first.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
mv_last.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
mv_max.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
mv_median.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
mv_min.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
mv_slice.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
mv_sort.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
mv_sum.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
mv_zip.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
now.asciidoc [DOCS] Improve ES|QL functions reference for functions E-Z (#104623) 2024-01-25 16:32:24 +01:00
operators.asciidoc [ESQL] Remove is_nan, is_finite, and is_infinite (#104091) 2024-01-09 14:51:32 -05:00
percentile.asciidoc [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) 2024-01-30 19:29:12 +01:00
pi.asciidoc [DOCS] Improve ES|QL functions reference for functions E-Z (#104623) 2024-01-25 16:32:24 +01:00
pow.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
predicates.asciidoc [DOCS] Examples for ES|QL DISSECT and WHERE (#102591) 2023-11-27 10:56:48 +01:00
README.md Fix typo in functions/README.md (#106870) 2024-03-28 14:02:47 +01:00
replace.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
right.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
rlike.asciidoc [DOCS] Examples for ES|QL DISSECT and WHERE (#102591) 2023-11-27 10:56:48 +01:00
round.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
rtrim.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
spatial-functions.asciidoc Support ST_INTERSECTS between two geometry columns (#104907) 2024-03-19 17:58:37 +01:00
split.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
sqrt.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
st_centroid.asciidoc Fix automatic generation of spatial function types files (#105766) 2024-03-05 18:04:09 +01:00
st_intersects.asciidoc Support ST_INTERSECTS between two geometry columns (#104907) 2024-03-19 17:58:37 +01:00
st_x.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
st_y.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
starts_with.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
string-functions.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
substring.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
sum.asciidoc [DOCS] Support for nested functions in ES|QL STATS...BY (#104788) 2024-01-30 19:29:12 +01:00
tau.asciidoc [DOCS] Improve ES|QL functions reference for functions E-Z (#104623) 2024-01-25 16:32:24 +01:00
to_boolean.asciidoc [DOCS] Improve ES|QL functions reference for functions E-Z (#104623) 2024-01-25 16:32:24 +01:00
to_cartesianpoint.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
to_cartesianshape.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
to_datetime.asciidoc [DOCS] Improve ES|QL functions reference for functions E-Z (#104623) 2024-01-25 16:32:24 +01:00
to_degrees.asciidoc [DOCS] Improve ES|QL functions reference for functions E-Z (#104623) 2024-01-25 16:32:24 +01:00
to_double.asciidoc [DOCS] Improve ES|QL functions reference for functions E-Z (#104623) 2024-01-25 16:32:24 +01:00
to_geopoint.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
to_geoshape.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
to_integer.asciidoc [DOCS] Improve ES|QL functions reference for functions E-Z (#104623) 2024-01-25 16:32:24 +01:00
to_ip.asciidoc [DOCS] Improve ES|QL functions reference for functions E-Z (#104623) 2024-01-25 16:32:24 +01:00
to_long.asciidoc [DOCS] Improve ES|QL functions reference for functions E-Z (#104623) 2024-01-25 16:32:24 +01:00
to_lower.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
to_radians.asciidoc [DOCS] Improve ES|QL functions reference for functions E-Z (#104623) 2024-01-25 16:32:24 +01:00
to_string.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
to_unsigned_long.asciidoc ESQL: Mark a few features as experimental (#105263) 2024-02-07 17:28:13 -08:00
to_upper.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
to_version.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
trim.asciidoc ESQL: Generate more docs (#106367) 2024-03-19 15:40:13 -04:00
type-conversion-functions.asciidoc ESQL: Mark a few features as experimental (#105263) 2024-02-07 17:28:13 -08:00
unary.asciidoc ESQL: Add type tables for operators to docs (#103206) 2023-12-11 10:51:38 -05:00
values.asciidoc ESQL: Values aggregation function (#106065) 2024-03-21 12:52:04 -04:00

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

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