root
/
elasticsearch
mirror of https://github.com/elastic/elasticsearch.git
1
0
Fork 0
Code Issues Actions 1 Packages Projects Releases Wiki Activity
elasticsearch/docs/reference/esql/functions/mv-functions.asciidoc

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

47 lines
1.2 KiB
Plaintext
Raw Normal View History

Restructure ES|QL docs (#100806) * Break out 'Limitations' into separate page * Add REST API docs * Restructure commands, functions, and operators refs * Add placeholder for getting started guide * Group 'Syntax', 'Metafields', and 'MV fields' under 'Language' * Add placeholder for Kibana page * Add link from landing page * Apply uniform formatting to ACOS, CASE, and DATE_PARSE function refs * Reword default LIMIT * Add support for COUNT(*) * Move 'Commands' and 'Functions and operators' to individual pages --------- Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2023-10-17 23:36:14 +08:00
[[esql-mv-functions]]
Add improvements to the ES|QL docs (#101195) Content and structural improvements to the ES|QL docs --------- Co-authored-by: Alexandros Batsakis <abatsakis@splunk.com> Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>
2023-10-23 22:45:42 +08:00
==== {esql} multivalue functions
Restructure ES|QL docs (#100806) * Break out 'Limitations' into separate page * Add REST API docs * Restructure commands, functions, and operators refs * Add placeholder for getting started guide * Group 'Syntax', 'Metafields', and 'MV fields' under 'Language' * Add placeholder for Kibana page * Add link from landing page * Apply uniform formatting to ACOS, CASE, and DATE_PARSE function refs * Reword default LIMIT * Add support for COUNT(*) * Move 'Commands' and 'Functions and operators' to individual pages --------- Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2023-10-17 23:36:14 +08:00
++++
<titleabbrev>Multivalue functions</titleabbrev>
++++
{esql} supports these multivalue functions:
Add improvements to the ES|QL docs (#101195) Content and structural improvements to the ES|QL docs --------- Co-authored-by: Alexandros Batsakis <abatsakis@splunk.com> Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>
2023-10-23 22:45:42 +08:00
// tag::mv_list[]
ES|QL: reduce memory footprint for MvAppendTests with shapes (#109517) Fixing MvAppendTests CB exceptions by generating smaller geometries: the test generates a lot of documents and the CB is too small for multiple big shapes. Fixes https://github.com/elastic/elasticsearch/issues/109409
2024-06-13 00:44:49 +08:00
* <<esql-mv_append>>
Restructure ES|QL docs (#100806) * Break out 'Limitations' into separate page * Add REST API docs * Restructure commands, functions, and operators refs * Add placeholder for getting started guide * Group 'Syntax', 'Metafields', and 'MV fields' under 'Language' * Add placeholder for Kibana page * Add link from landing page * Apply uniform formatting to ACOS, CASE, and DATE_PARSE function refs * Reword default LIMIT * Add support for COUNT(*) * Move 'Commands' and 'Functions and operators' to individual pages --------- Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2023-10-17 23:36:14 +08:00
* <<esql-mv_avg>>
* <<esql-mv_concat>>
* <<esql-mv_count>>
* <<esql-mv_dedupe>>
ESQL: `MV_FIRST` and `MV_LAST` (#103928) This creates the `MV_FIRST` and `MV_LAST` functions that return the first and last values from a multivalue field. They are noops from a single valued field. They are quite similar to `MV_MIN` and `MV_MAX` except they work on positional data rather than relative size. That sounds like a large distinction, but in practice our multivalued fields are often sorted. And when they operate on sorted arrays `MV_MIN` does *the same* thing as `MV_FIRST`. But there are some cases where it really does matter - say you are `SPLIT`ing something - so `MV_FIRST(SPLIT("foo;bar;baz", ";"))` gets you `foo` like you'd expect. No sorting needed. Relates to #103879
2024-01-09 21:46:34 +08:00
* <<esql-mv_first>>
* <<esql-mv_last>>
Restructure ES|QL docs (#100806) * Break out 'Limitations' into separate page * Add REST API docs * Restructure commands, functions, and operators refs * Add placeholder for getting started guide * Group 'Syntax', 'Metafields', and 'MV fields' under 'Language' * Add placeholder for Kibana page * Add link from landing page * Apply uniform formatting to ACOS, CASE, and DATE_PARSE function refs * Reword default LIMIT * Add support for COUNT(*) * Move 'Commands' and 'Functions and operators' to individual pages --------- Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2023-10-17 23:36:14 +08:00
* <<esql-mv_max>>
* <<esql-mv_median>>
ESQL: mv_median_absolute_deviation function (#112055) - Added mv_median_absolute_deviation function - Added possibility of having a fixed param in Multivalue "ascending" functions - Add surrogate to MedianAbsoluteDeviation ### Calculations used to avoid overflows First, a quick recap of how the MAD is calculated: 1. Sort values, and get the median 2. Calculate the difference between each value with the median (`abs(median - value)`) 3. Sort the differences, and get their median Calculating a MAD may overflow when calculating the differences (Step 2), given the type is a signed number, as the difference is a positive value, with potentially the same value as `POSITIVE_MAX - NEGATIVE_MIN`. To solve this, some types are up-casted as follow: - Int: Stored as longs, simple approach - Long: Stored as longs, but switched to unsigned long representation when calculating the differences - Unsigned long: No effect; the resulting range is the same - Doubles: Nothing. If the values overflow to +/-infinity, they're left that way, as we'll just use those outliers to sort Closes https://github.com/elastic/elasticsearch/issues/111590
2024-09-09 16:04:25 +08:00
* <<esql-mv_median_absolute_deviation>>
Restructure ES|QL docs (#100806) * Break out 'Limitations' into separate page * Add REST API docs * Restructure commands, functions, and operators refs * Add placeholder for getting started guide * Group 'Syntax', 'Metafields', and 'MV fields' under 'Language' * Add placeholder for Kibana page * Add link from landing page * Apply uniform formatting to ACOS, CASE, and DATE_PARSE function refs * Reword default LIMIT * Add support for COUNT(*) * Move 'Commands' and 'Functions and operators' to individual pages --------- Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2023-10-17 23:36:14 +08:00
* <<esql-mv_min>>
ESQL: Add docs for MV_PERCENTILE (#117377) We built this a while back. Let's document it.
2024-11-23 03:41:18 +08:00
* <<esql-mv_percentile>>
ESQL: Add `MV_PSERIES_WEIGHTED_SUM` for score calculations used by security solution (#109017) * Create MV_RIEMANN_ZETA scalar multivalue function --------- Co-authored-by: Nik Everett <nik9000@gmail.com>
2024-07-31 18:08:28 +08:00
* <<esql-mv_pseries_weighted_sum>>
[ES|QL] Add mv_sort (#106095) * add mv_sort
2024-03-14 00:04:12 +08:00
* <<esql-mv_sort>>
add mv_slice and mv_zip (#106147)
2024-03-12 11:02:57 +08:00
* <<esql-mv_slice>>
Restructure ES|QL docs (#100806) * Break out 'Limitations' into separate page * Add REST API docs * Restructure commands, functions, and operators refs * Add placeholder for getting started guide * Group 'Syntax', 'Metafields', and 'MV fields' under 'Language' * Add placeholder for Kibana page * Add link from landing page * Apply uniform formatting to ACOS, CASE, and DATE_PARSE function refs * Reword default LIMIT * Add support for COUNT(*) * Move 'Commands' and 'Functions and operators' to individual pages --------- Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2023-10-17 23:36:14 +08:00
* <<esql-mv_sum>>
add mv_slice and mv_zip (#106147)
2024-03-12 11:02:57 +08:00
* <<esql-mv_zip>>
Add improvements to the ES|QL docs (#101195) Content and structural improvements to the ES|QL docs --------- Co-authored-by: Alexandros Batsakis <abatsakis@splunk.com> Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>
2023-10-23 22:45:42 +08:00
// end::mv_list[]
Restructure ES|QL docs (#100806) * Break out 'Limitations' into separate page * Add REST API docs * Restructure commands, functions, and operators refs * Add placeholder for getting started guide * Group 'Syntax', 'Metafields', and 'MV fields' under 'Language' * Add placeholder for Kibana page * Add link from landing page * Apply uniform formatting to ACOS, CASE, and DATE_PARSE function refs * Reword default LIMIT * Add support for COUNT(*) * Move 'Commands' and 'Functions and operators' to individual pages --------- Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2023-10-17 23:36:14 +08:00
ES|QL: reduce memory footprint for MvAppendTests with shapes (#109517) Fixing MvAppendTests CB exceptions by generating smaller geometries: the test generates a lot of documents and the CB is too small for multiple big shapes. Fixes https://github.com/elastic/elasticsearch/issues/109409
2024-06-13 00:44:49 +08:00
include::layout/mv_append.asciidoc[]
mv functions (#107839) Add annotations for MV functions for better doc generation.
2024-05-01 22:47:22 +08:00
include::layout/mv_avg.asciidoc[]
include::layout/mv_concat.asciidoc[]
include::layout/mv_count.asciidoc[]
include::layout/mv_dedupe.asciidoc[]
include::layout/mv_first.asciidoc[]
include::layout/mv_last.asciidoc[]
include::layout/mv_max.asciidoc[]
include::layout/mv_median.asciidoc[]
ESQL: mv_median_absolute_deviation function (#112055) - Added mv_median_absolute_deviation function - Added possibility of having a fixed param in Multivalue "ascending" functions - Add surrogate to MedianAbsoluteDeviation ### Calculations used to avoid overflows First, a quick recap of how the MAD is calculated: 1. Sort values, and get the median 2. Calculate the difference between each value with the median (`abs(median - value)`) 3. Sort the differences, and get their median Calculating a MAD may overflow when calculating the differences (Step 2), given the type is a signed number, as the difference is a positive value, with potentially the same value as `POSITIVE_MAX - NEGATIVE_MIN`. To solve this, some types are up-casted as follow: - Int: Stored as longs, simple approach - Long: Stored as longs, but switched to unsigned long representation when calculating the differences - Unsigned long: No effect; the resulting range is the same - Doubles: Nothing. If the values overflow to +/-infinity, they're left that way, as we'll just use those outliers to sort Closes https://github.com/elastic/elasticsearch/issues/111590
2024-09-09 16:04:25 +08:00
include::layout/mv_median_absolute_deviation.asciidoc[]
mv functions (#107839) Add annotations for MV functions for better doc generation.
2024-05-01 22:47:22 +08:00
include::layout/mv_min.asciidoc[]
ESQL: Add docs for MV_PERCENTILE (#117377) We built this a while back. Let's document it.
2024-11-23 03:41:18 +08:00
include::layout/mv_percentile.asciidoc[]
ESQL: Add `MV_PSERIES_WEIGHTED_SUM` for score calculations used by security solution (#109017) * Create MV_RIEMANN_ZETA scalar multivalue function --------- Co-authored-by: Nik Everett <nik9000@gmail.com>
2024-07-31 18:08:28 +08:00
include::layout/mv_pseries_weighted_sum.asciidoc[]
mv functions (#107839) Add annotations for MV functions for better doc generation.
2024-05-01 22:47:22 +08:00
include::layout/mv_slice.asciidoc[]
include::layout/mv_sort.asciidoc[]
include::layout/mv_sum.asciidoc[]
include::layout/mv_zip.asciidoc[]