elasticsearch/docs/reference/query-languages/esql/_snippets/functions/examples
Craig Taverner 8ffecb408d
Additional support for docs for ES|QL operators and version-specific differentiation (#125251)
This PR was originally focused on improving support for Kibana docs, in particular the missing operator docs, but it has expanded to cover a bunch of related things:

* Primarily the main work was to improve operators support. ESQL generated docs cover all functions and most operators for which their is a clear operator class and test class. However, some are built-in behaviour and need additional support. This PR adds more generated content for those operators.
* Various specific operators requested by Kibana: Cast & null-predicates, and in particular the addition of examples
* Two functions without examples: mv_append and to_date_nanos
* Many small visual document cleanups (spelling, grammar, capitalization, etc.)
* Initial support for `applies_to` for multi-version differentiation.

This last point requires more work, as it is not yet agreed on just how we want this to look. We'll probably need to do refinements in followup PR. Consider the version in this PR as a first step into how this could look.
2025-03-24 09:56:45 +01:00
..
abs.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
acos.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
asin.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
atan.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
atan2.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
avg.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
bit_length.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
bucket.md [docs] Prepare for docs-assembler (#125118) 2025-03-20 12:09:12 -05:00
byte_length.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
case.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
categorize.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
cbrt.md Additional support for docs for ES|QL operators and version-specific differentiation (#125251) 2025-03-24 09:56:45 +01:00
ceil.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
cidr_match.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
coalesce.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
concat.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
cos.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
cosh.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
count.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
count_distinct.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
date_diff.md Additional support for docs for ES|QL operators and version-specific differentiation (#125251) 2025-03-24 09:56:45 +01:00
date_extract.md Additional support for docs for ES|QL operators and version-specific differentiation (#125251) 2025-03-24 09:56:45 +01:00
date_format.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
date_parse.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
date_trunc.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
e.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
ends_with.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
exp.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
floor.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
from_base64.md Additional support for docs for ES|QL operators and version-specific differentiation (#125251) 2025-03-24 09:56:45 +01:00
greatest.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
hash.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
hypot.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
ip_prefix.md Additional support for docs for ES|QL operators and version-specific differentiation (#125251) 2025-03-24 09:56:45 +01:00
kql.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
least.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
left.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
length.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
locate.md Additional support for docs for ES|QL operators and version-specific differentiation (#125251) 2025-03-24 09:56:45 +01:00
log.md Additional support for docs for ES|QL operators and version-specific differentiation (#125251) 2025-03-24 09:56:45 +01:00
log10.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
ltrim.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
match.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
max.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
md5.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
median.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
median_absolute_deviation.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
min.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
mv_append.md Additional support for docs for ES|QL operators and version-specific differentiation (#125251) 2025-03-24 09:56:45 +01:00
mv_avg.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
mv_concat.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
mv_count.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
mv_dedupe.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
mv_first.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
mv_last.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
mv_max.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
mv_median.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
mv_median_absolute_deviation.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
mv_min.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
mv_percentile.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
mv_pseries_weighted_sum.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
mv_slice.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
mv_sort.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
mv_sum.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
mv_zip.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
now.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
percentile.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
pi.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
pow.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
qstr.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
repeat.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
replace.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
reverse.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
right.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
round.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
rtrim.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
sha1.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
sha256.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
signum.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
sin.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
sinh.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
space.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
split.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
sqrt.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
st_centroid_agg.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
st_contains.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
st_disjoint.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
st_distance.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
st_envelope.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
st_extent_agg.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
st_intersects.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
st_within.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
st_x.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
st_xmax.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
st_xmin.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
st_y.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
st_ymax.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
st_ymin.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
starts_with.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
std_dev.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
substring.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
sum.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
tan.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
tanh.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
tau.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
term.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
to_base64.md Additional support for docs for ES|QL operators and version-specific differentiation (#125251) 2025-03-24 09:56:45 +01:00
to_boolean.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
to_cartesianpoint.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
to_cartesianshape.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
to_date_nanos.md Additional support for docs for ES|QL operators and version-specific differentiation (#125251) 2025-03-24 09:56:45 +01:00
to_dateperiod.md Additional support for docs for ES|QL operators and version-specific differentiation (#125251) 2025-03-24 09:56:45 +01:00
to_datetime.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
to_degrees.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
to_double.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
to_geopoint.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
to_geoshape.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
to_integer.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
to_ip.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
to_long.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
to_lower.md Restructure query-languages docs files for clarity (#124797) 2025-03-17 17:58:58 +01:00
to_radians.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
to_string.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
to_timeduration.md Additional support for docs for ES|QL operators and version-specific differentiation (#125251) 2025-03-24 09:56:45 +01:00
to_unsigned_long.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
to_upper.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
to_version.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
top.md Split ESQL functions/operators docs files (#123904) 2025-03-04 14:59:31 +01:00
trim.md ESQL autogenerate docs v3 (#124312) 2025-03-13 14:16:46 +01:00
values.md Additional support for docs for ES|QL operators and version-specific differentiation (#125251) 2025-03-24 09:56:45 +01:00
weighted_avg.md Additional support for docs for ES|QL operators and version-specific differentiation (#125251) 2025-03-24 09:56:45 +01:00