elasticsearch/docs/reference/esql/functions
Mark Tozzi cafa440771
[8.x] Esql Enable Date Nanos (#117080) (#117161)
* Esql Enable Date Nanos (#117080)

This enables date nanos support as tech preview. Basic operations, like reading values, binary comparisons, and functions that don't care about type should work, but some functions are not yet supported. Most notably, Bucket is not yet supported, although Date_Trunc is and can be used for grouping. See the docs for the full list of limitations.

relates to #109352

* Skip CATEGORIZE tests outside snapshot

---------

Co-authored-by: Nik Everett <nik9000@gmail.com>
2024-11-21 08:16:59 +11:00
..
appendix ESQL: Add COUNT and COUNT_DISTINCT aggregation tests (#111409) 2024-07-30 03:07:15 +10:00
description [8.x] [ESQL] Add support BYTE_LENGTH scalar function (#116591) (#116731) 2024-11-14 14:40:42 +01:00
examples ESQL: Docs: COUNT: add an explanation to the use of the 3VL (#116684) (#117006) 2024-11-19 21:43:31 +11:00
kibana [8.x] Esql Enable Date Nanos (#117080) (#117161) 2024-11-21 08:16:59 +11:00
layout [8.x] [ESQL] Add support BYTE_LENGTH scalar function (#116591) (#116731) 2024-11-14 14:40:42 +01:00
parameters [8.x] [ESQL] Add support BYTE_LENGTH scalar function (#116591) (#116731) 2024-11-14 14:40:42 +01:00
signature [8.x] [ESQL] Add support BYTE_LENGTH scalar function (#116591) (#116731) 2024-11-14 14:40:42 +01:00
types [8.x] Esql Enable Date Nanos (#117080) (#117161) 2024-11-21 08:16:59 +11:00
aggregation-functions.asciidoc ESQL: WEIGHTED_AVG aggregation tests and docs (#111449) 2024-07-31 00:42:23 +10:00
binary.asciidoc [ES|QL][DOCS] Add docs for date_period and time_duration (#116368) (#117021) 2024-11-20 00:14:46 +11:00
cast.asciidoc ESQL: Document the cast operator (::) (#107871) 2024-04-25 10:10:59 -04:00
conditional-functions-and-expressions.asciidoc [ES|QL] Add/Modify annotations for spatial and conditional functions for better doc generation (#107722) 2024-05-10 14:49:25 -04:00
date-time-functions.asciidoc ES|QL: Add unit tests for now() function (#108498) 2024-05-10 14:28:19 +02:00
grouping-functions.asciidoc ESQL: Document BUCKET as a grouping function (#107864) 2024-04-25 12:38:12 -04:00
in.asciidoc [DOCS] Examples for ES|QL DISSECT and WHERE (#102591) 2023-11-27 10:56:48 +01:00
ip-functions.asciidoc ESQL: Add aggregations testing base and docs (#110042) 2024-06-27 21:21:55 +10:00
like.asciidoc ES|QL: improve docs about escaping for GROK, DISSECT, LIKE, RLIKE (#115320) (#115493) 2024-10-24 19:14:57 +11:00
logical.asciidoc Restructure ES|QL docs (#100806) 2023-10-17 17:36:14 +02:00
math-functions.asciidoc [ES|QL] Add hypot function (#114382) (#114658) 2024-10-12 07:45:43 +11:00
mv-functions.asciidoc ESQL: mv_median_absolute_deviation function (#112055) 2024-09-09 10:04:25 +02:00
operators.asciidoc Introduce an IP functions group (#108304) 2024-05-06 13:43:30 +02:00
predicates.asciidoc [DOCS] Examples for ES|QL DISSECT and WHERE (#102591) 2023-11-27 10:56:48 +01:00
README.md ESQL: Generate kibana inline docs (#106782) 2024-04-09 14:19:48 -04:00
rlike.asciidoc ES|QL: improve docs about escaping for GROK, DISSECT, LIKE, RLIKE (#115320) (#115493) 2024-10-24 19:14:57 +11:00
search-functions.asciidoc ES|QL Add full-text search to the functions docs page (#116024) 2024-11-01 12:08:48 +00:00
spatial-functions.asciidoc ES|QL ST_DISTANCE Function (#108764) 2024-06-21 11:59:44 +02:00
string-functions.asciidoc [8.x] [ESQL] Add support BYTE_LENGTH scalar function (#116591) (#116731) 2024-11-14 14:40:42 +01:00
type-conversion-functions.asciidoc [ES|QL] explicit cast a string literal to date_period and time_duration in arithmetic operations (#109193) 2024-09-09 14:56:43 -04:00
unary.asciidoc ESQL: Add type tables for operators to docs (#103206) 2023-12-11 10:51:38 -05:00

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