honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference/sql/functions/aggs.asciidoc

719 lines
20 KiB
Plaintext
Raw Normal View History

DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
[role="xpack"]
[testenv="basic"]
[[sql-functions-aggs]]
=== Aggregate Functions
Functions for computing a _single_ result from a set of input values.
{es-sql} supports aggregate functions only alongside <<sql-syntax-group-by,grouping>> (implicit or explicit).
SQL: MATCH and QUERY documentation; one list of functions (#40494) * Document MATCH and QUERY function predicates. * Polish the functions pages and add a list of functions to the main Functions & Operators page. (cherry picked from commit 4cec0ae1b962ec7ea011a290aec72740386eb808)
2019-03-27 11:18:14 -04:00
[[sql-functions-aggs-general]]
[DOCS] Swap `[float]` for `[discrete]` (#60134) Changes instances of `[float]` in our docs for `[discrete]`. Asciidoctor prefers the `[discrete]` tag for floating headings: https://asciidoctor.org/docs/asciidoc-asciidoctor-diffs/#blocks
2020-07-23 12:42:33 -04:00
[discrete]
SQL: MATCH and QUERY documentation; one list of functions (#40494) * Document MATCH and QUERY function predicates. * Polish the functions pages and add a list of functions to the main Functions & Operators page. (cherry picked from commit 4cec0ae1b962ec7ea011a290aec72740386eb808)
2019-03-27 11:18:14 -04:00
=== General Purpose
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
[[sql-functions-aggs-avg]]
SQL: MATCH and QUERY documentation; one list of functions (#40494) * Document MATCH and QUERY function predicates. * Polish the functions pages and add a list of functions to the main Functions & Operators page. (cherry picked from commit 4cec0ae1b962ec7ea011a290aec72740386eb808)
2019-03-27 11:18:14 -04:00
==== `AVG`
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
.Synopsis:
[source, sql]
--------------------------------------------------
[DOCS] Remove inline callouts for Asciidoctor migration (#41309)
2019-04-22 09:33:55 -04:00
AVG(numeric_field) <1>
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
--------------------------------------------------
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
*Input*:
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
<1> numeric field
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
*Output*: `double` numeric value
SQL: document the use of a filter on _routing (#52355) * Fix "Description"s for various sections in the functions pages. * Added a TIP for searching using a routing key. * Other small polishings (cherry picked from commit 9fad0b1ac4409a42c435ed040f41cbaea18930a3)
2020-02-14 11:58:45 -05:00
*Description*: Returns the https://en.wikipedia.org/wiki/Arithmetic_mean[Average] (arithmetic mean) of input values.
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
["source","sql",subs="attributes,macros"]
--------------------------------------------------
SQL: Spec tests now use classpath discovery (#40388) To avoid having to specify each spec by hand (which can miss specs to be added), the test infrastructure now performs classpath discovery so that each spec added, is automatically considered. Relates #40358 (cherry picked from commit d0f60b4425c731509aa8ca765d55f563f866ef90)
2019-03-25 09:22:59 -04:00
include-tagged::{sql-specs}/docs/docs.csv-spec[aggAvg]
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
--------------------------------------------------
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: Implement scripting inside aggs (#55241) (#55371) Implement the use of scalar functions inside aggregate functions. This allows for complex expressions inside aggregations, with or without GROUBY as well as with or without a HAVING clause. e.g.: ``` SELECT MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) AS max, b FROM test GROUP BY b HAVING MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) > 5 ``` Scalar functions are still not allowed for `KURTOSIS` and `SKEWNESS` as this is currently not implemented on the ElasticSearch side. Fixes: #29980 Fixes: #36865 Fixes: #37271 (cherry picked from commit 506d1beea7abb2b45de793bba2e349090a78f2f9)
2020-04-17 06:41:22 -04:00
["source","sql",subs="attributes,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/docs/docs.csv-spec[aggAvgScalars]
--------------------------------------------------
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
[[sql-functions-aggs-count]]
SQL: MATCH and QUERY documentation; one list of functions (#40494) * Document MATCH and QUERY function predicates. * Polish the functions pages and add a list of functions to the main Functions & Operators page. (cherry picked from commit 4cec0ae1b962ec7ea011a290aec72740386eb808)
2019-03-27 11:18:14 -04:00
==== `COUNT`
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
.Synopsis:
[source, sql]
--------------------------------------------------
[DOCS] Remove inline callouts for Asciidoctor migration (#41309)
2019-04-22 09:33:55 -04:00
COUNT(expression) <1>
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
--------------------------------------------------
*Input*:
<1> a field name, wildcard (`*`) or any numeric value
*Output*: numeric value
SQL: document the use of a filter on _routing (#52355) * Fix "Description"s for various sections in the functions pages. * Added a TIP for searching using a routing key. * Other small polishings (cherry picked from commit 9fad0b1ac4409a42c435ed040f41cbaea18930a3)
2020-02-14 11:58:45 -05:00
*Description*: Returns the total number (count) of input values.
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: Proper handling of COUNT(field_name) and COUNT(DISTINCT field_name) (#37254) * provide overriden `hashCode` and toString methods to account for `DISTINCT` * change the analyzer for scenarios where `COUNT <field_name>` and `COUNT DISTINCT` have different paths * defined a new `filter` aggregation encapsulating an `exists` query to filter out null or missing values
2019-01-10 02:51:51 -05:00
In case of `COUNT(*)` or `COUNT(<literal>)`, _all_ values are considered (including `null` or missing ones).
In case of `COUNT(<field_name>)` `null` values are not considered.
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
["source","sql",subs="attributes,macros"]
--------------------------------------------------
SQL: Spec tests now use classpath discovery (#40388) To avoid having to specify each spec by hand (which can miss specs to be added), the test infrastructure now performs classpath discovery so that each spec added, is automatically considered. Relates #40358 (cherry picked from commit d0f60b4425c731509aa8ca765d55f563f866ef90)
2019-03-25 09:22:59 -04:00
include-tagged::{sql-specs}/docs/docs.csv-spec[aggCountStar]
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
--------------------------------------------------
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: Proper handling of COUNT(field_name) and COUNT(DISTINCT field_name) (#37254) * provide overriden `hashCode` and toString methods to account for `DISTINCT` * change the analyzer for scenarios where `COUNT <field_name>` and `COUNT DISTINCT` have different paths * defined a new `filter` aggregation encapsulating an `exists` query to filter out null or missing values
2019-01-10 02:51:51 -05:00
[[sql-functions-aggs-count-all]]
SQL: MATCH and QUERY documentation; one list of functions (#40494) * Document MATCH and QUERY function predicates. * Polish the functions pages and add a list of functions to the main Functions & Operators page. (cherry picked from commit 4cec0ae1b962ec7ea011a290aec72740386eb808)
2019-03-27 11:18:14 -04:00
==== `COUNT(ALL)`
SQL: Proper handling of COUNT(field_name) and COUNT(DISTINCT field_name) (#37254) * provide overriden `hashCode` and toString methods to account for `DISTINCT` * change the analyzer for scenarios where `COUNT <field_name>` and `COUNT DISTINCT` have different paths * defined a new `filter` aggregation encapsulating an `exists` query to filter out null or missing values
2019-01-10 02:51:51 -05:00
.Synopsis:
[source, sql]
--------------------------------------------------
[DOCS] Remove inline callouts for Asciidoctor migration (#41309)
2019-04-22 09:33:55 -04:00
COUNT(ALL field_name) <1>
SQL: Proper handling of COUNT(field_name) and COUNT(DISTINCT field_name) (#37254) * provide overriden `hashCode` and toString methods to account for `DISTINCT` * change the analyzer for scenarios where `COUNT <field_name>` and `COUNT DISTINCT` have different paths * defined a new `filter` aggregation encapsulating an `exists` query to filter out null or missing values
2019-01-10 02:51:51 -05:00
--------------------------------------------------
*Input*:
<1> a field name
*Output*: numeric value
SQL: document the use of a filter on _routing (#52355) * Fix "Description"s for various sections in the functions pages. * Added a TIP for searching using a routing key. * Other small polishings (cherry picked from commit 9fad0b1ac4409a42c435ed040f41cbaea18930a3)
2020-02-14 11:58:45 -05:00
*Description*: Returns the total number (count) of all _non-null_ input values. `COUNT(<field_name>)` and `COUNT(ALL <field_name>)` are equivalent.
SQL: Proper handling of COUNT(field_name) and COUNT(DISTINCT field_name) (#37254) * provide overriden `hashCode` and toString methods to account for `DISTINCT` * change the analyzer for scenarios where `COUNT <field_name>` and `COUNT DISTINCT` have different paths * defined a new `filter` aggregation encapsulating an `exists` query to filter out null or missing values
2019-01-10 02:51:51 -05:00
["source","sql",subs="attributes,macros"]
--------------------------------------------------
SQL: Spec tests now use classpath discovery (#40388) To avoid having to specify each spec by hand (which can miss specs to be added), the test infrastructure now performs classpath discovery so that each spec added, is automatically considered. Relates #40358 (cherry picked from commit d0f60b4425c731509aa8ca765d55f563f866ef90)
2019-03-25 09:22:59 -04:00
include-tagged::{sql-specs}/docs/docs.csv-spec[aggCountAll]
SQL: Proper handling of COUNT(field_name) and COUNT(DISTINCT field_name) (#37254) * provide overriden `hashCode` and toString methods to account for `DISTINCT` * change the analyzer for scenarios where `COUNT <field_name>` and `COUNT DISTINCT` have different paths * defined a new `filter` aggregation encapsulating an `exists` query to filter out null or missing values
2019-01-10 02:51:51 -05:00
--------------------------------------------------
SQL: Implement scripting inside aggs (#55241) (#55371) Implement the use of scalar functions inside aggregate functions. This allows for complex expressions inside aggregations, with or without GROUBY as well as with or without a HAVING clause. e.g.: ``` SELECT MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) AS max, b FROM test GROUP BY b HAVING MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) > 5 ``` Scalar functions are still not allowed for `KURTOSIS` and `SKEWNESS` as this is currently not implemented on the ElasticSearch side. Fixes: #29980 Fixes: #36865 Fixes: #37271 (cherry picked from commit 506d1beea7abb2b45de793bba2e349090a78f2f9)
2020-04-17 06:41:22 -04:00
["source","sql",subs="attributes,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/docs/docs.csv-spec[aggCountAllScalars]
--------------------------------------------------
SQL: Proper handling of COUNT(field_name) and COUNT(DISTINCT field_name) (#37254) * provide overriden `hashCode` and toString methods to account for `DISTINCT` * change the analyzer for scenarios where `COUNT <field_name>` and `COUNT DISTINCT` have different paths * defined a new `filter` aggregation encapsulating an `exists` query to filter out null or missing values
2019-01-10 02:51:51 -05:00
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
[[sql-functions-aggs-count-distinct]]
SQL: MATCH and QUERY documentation; one list of functions (#40494) * Document MATCH and QUERY function predicates. * Polish the functions pages and add a list of functions to the main Functions & Operators page. (cherry picked from commit 4cec0ae1b962ec7ea011a290aec72740386eb808)
2019-03-27 11:18:14 -04:00
==== `COUNT(DISTINCT)`
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
.Synopsis:
[source, sql]
--------------------------------------------------
[DOCS] Remove inline callouts for Asciidoctor migration (#41309)
2019-04-22 09:33:55 -04:00
COUNT(DISTINCT field_name) <1>
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
--------------------------------------------------
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
*Input*:
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
<1> a field name
*Output*: numeric value
SQL: document the use of a filter on _routing (#52355) * Fix "Description"s for various sections in the functions pages. * Added a TIP for searching using a routing key. * Other small polishings (cherry picked from commit 9fad0b1ac4409a42c435ed040f41cbaea18930a3)
2020-02-14 11:58:45 -05:00
*Description*: Returns the total number of _distinct non-null_ values in input values.
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
["source","sql",subs="attributes,macros"]
--------------------------------------------------
SQL: Spec tests now use classpath discovery (#40388) To avoid having to specify each spec by hand (which can miss specs to be added), the test infrastructure now performs classpath discovery so that each spec added, is automatically considered. Relates #40358 (cherry picked from commit d0f60b4425c731509aa8ca765d55f563f866ef90)
2019-03-25 09:22:59 -04:00
include-tagged::{sql-specs}/docs/docs.csv-spec[aggCountDistinct]
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
--------------------------------------------------
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: Implement scripting inside aggs (#55241) (#55371) Implement the use of scalar functions inside aggregate functions. This allows for complex expressions inside aggregations, with or without GROUBY as well as with or without a HAVING clause. e.g.: ``` SELECT MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) AS max, b FROM test GROUP BY b HAVING MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) > 5 ``` Scalar functions are still not allowed for `KURTOSIS` and `SKEWNESS` as this is currently not implemented on the ElasticSearch side. Fixes: #29980 Fixes: #36865 Fixes: #37271 (cherry picked from commit 506d1beea7abb2b45de793bba2e349090a78f2f9)
2020-04-17 06:41:22 -04:00
["source","sql",subs="attributes,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/docs/docs.csv-spec[aggCountDistinctScalars]
--------------------------------------------------
SQL: Implement FIRST/LAST aggregate functions (#37936) FIRST and LAST can be used with one argument and work similarly to MIN and MAX but they are implemented using a Top Hits aggregation and therefore can also operate on keyword fields. When a second argument is provided then they return the first/last value of the first arg when its values are ordered ascending/descending (respectively) by the values of the second argument. Currently because of the usage of a Top Hits aggregation FIRST and LAST cannot be used in the HAVING clause of a GROUP BY query to filter on the results of the aggregation. Closes: #35639
2019-01-31 09:33:05 -05:00
[[sql-functions-aggs-first]]
SQL: MATCH and QUERY documentation; one list of functions (#40494) * Document MATCH and QUERY function predicates. * Polish the functions pages and add a list of functions to the main Functions & Operators page. (cherry picked from commit 4cec0ae1b962ec7ea011a290aec72740386eb808)
2019-03-27 11:18:14 -04:00
==== `FIRST/FIRST_VALUE`
SQL: Implement FIRST/LAST aggregate functions (#37936) FIRST and LAST can be used with one argument and work similarly to MIN and MAX but they are implemented using a Top Hits aggregation and therefore can also operate on keyword fields. When a second argument is provided then they return the first/last value of the first arg when its values are ordered ascending/descending (respectively) by the values of the second argument. Currently because of the usage of a Top Hits aggregation FIRST and LAST cannot be used in the HAVING clause of a GROUP BY query to filter on the results of the aggregation. Closes: #35639
2019-01-31 09:33:05 -05:00
.Synopsis:
[source, sql]
----------------------------------------------
[DOCS] Remove inline callouts for Asciidoctor migration (#41309)
2019-04-22 09:33:55 -04:00
FIRST(
field_name <1>
[, ordering_field_name]) <2>
SQL: Implement FIRST/LAST aggregate functions (#37936) FIRST and LAST can be used with one argument and work similarly to MIN and MAX but they are implemented using a Top Hits aggregation and therefore can also operate on keyword fields. When a second argument is provided then they return the first/last value of the first arg when its values are ordered ascending/descending (respectively) by the values of the second argument. Currently because of the usage of a Top Hits aggregation FIRST and LAST cannot be used in the HAVING clause of a GROUP BY query to filter on the results of the aggregation. Closes: #35639
2019-01-31 09:33:05 -05:00
----------------------------------------------
*Input*:
<1> target field for the aggregation
<2> optional field used for ordering
*Output*: same type as the input
SQL: document the use of a filter on _routing (#52355) * Fix "Description"s for various sections in the functions pages. * Added a TIP for searching using a routing key. * Other small polishings (cherry picked from commit 9fad0b1ac4409a42c435ed040f41cbaea18930a3)
2020-02-14 11:58:45 -05:00
*Description*: Returns the first **non-NULL** value (if such exists) of the `field_name` input column sorted by
SQL: Implement FIRST/LAST aggregate functions (#37936) FIRST and LAST can be used with one argument and work similarly to MIN and MAX but they are implemented using a Top Hits aggregation and therefore can also operate on keyword fields. When a second argument is provided then they return the first/last value of the first arg when its values are ordered ascending/descending (respectively) by the values of the second argument. Currently because of the usage of a Top Hits aggregation FIRST and LAST cannot be used in the HAVING clause of a GROUP BY query to filter on the results of the aggregation. Closes: #35639
2019-01-31 09:33:05 -05:00
the `ordering_field_name` column. If `ordering_field_name` is not provided, only the `field_name`
column is used for the sorting. E.g.:
[cols="<,<"]
|===
s| a | b
| 100 | 1
| 200 | 1
| 1 | 2
| 2 | 2
| 10 | null
| 20 | null
| null | null
|===
[source, sql]
----------------------
SELECT FIRST(a) FROM t
----------------------
will result in:
[cols="<"]
|===
s| FIRST(a)
| 1
|===
and
[source, sql]
-------------------------
SELECT FIRST(a, b) FROM t
-------------------------
will result in:
[cols="<"]
|===
s| FIRST(a, b)
| 100
|===
["source","sql",subs="attributes,macros"]
-----------------------------------------------------------
SQL: Spec tests now use classpath discovery (#40388) To avoid having to specify each spec by hand (which can miss specs to be added), the test infrastructure now performs classpath discovery so that each spec added, is automatically considered. Relates #40358 (cherry picked from commit d0f60b4425c731509aa8ca765d55f563f866ef90)
2019-03-25 09:22:59 -04:00
include-tagged::{sql-specs}/docs/docs.csv-spec[firstWithOneArg]
SQL: Implement FIRST/LAST aggregate functions (#37936) FIRST and LAST can be used with one argument and work similarly to MIN and MAX but they are implemented using a Top Hits aggregation and therefore can also operate on keyword fields. When a second argument is provided then they return the first/last value of the first arg when its values are ordered ascending/descending (respectively) by the values of the second argument. Currently because of the usage of a Top Hits aggregation FIRST and LAST cannot be used in the HAVING clause of a GROUP BY query to filter on the results of the aggregation. Closes: #35639
2019-01-31 09:33:05 -05:00
-----------------------------------------------------------
["source","sql",subs="attributes,macros"]
--------------------------------------------------------------------
SQL: Spec tests now use classpath discovery (#40388) To avoid having to specify each spec by hand (which can miss specs to be added), the test infrastructure now performs classpath discovery so that each spec added, is automatically considered. Relates #40358 (cherry picked from commit d0f60b4425c731509aa8ca765d55f563f866ef90)
2019-03-25 09:22:59 -04:00
include-tagged::{sql-specs}/docs/docs.csv-spec[firstWithOneArgAndGroupBy]
SQL: Implement FIRST/LAST aggregate functions (#37936) FIRST and LAST can be used with one argument and work similarly to MIN and MAX but they are implemented using a Top Hits aggregation and therefore can also operate on keyword fields. When a second argument is provided then they return the first/last value of the first arg when its values are ordered ascending/descending (respectively) by the values of the second argument. Currently because of the usage of a Top Hits aggregation FIRST and LAST cannot be used in the HAVING clause of a GROUP BY query to filter on the results of the aggregation. Closes: #35639
2019-01-31 09:33:05 -05:00
--------------------------------------------------------------------
["source","sql",subs="attributes,macros"]
-----------------------------------------------------------
SQL: Spec tests now use classpath discovery (#40388) To avoid having to specify each spec by hand (which can miss specs to be added), the test infrastructure now performs classpath discovery so that each spec added, is automatically considered. Relates #40358 (cherry picked from commit d0f60b4425c731509aa8ca765d55f563f866ef90)
2019-03-25 09:22:59 -04:00
include-tagged::{sql-specs}/docs/docs.csv-spec[firstWithTwoArgs]
SQL: Implement FIRST/LAST aggregate functions (#37936) FIRST and LAST can be used with one argument and work similarly to MIN and MAX but they are implemented using a Top Hits aggregation and therefore can also operate on keyword fields. When a second argument is provided then they return the first/last value of the first arg when its values are ordered ascending/descending (respectively) by the values of the second argument. Currently because of the usage of a Top Hits aggregation FIRST and LAST cannot be used in the HAVING clause of a GROUP BY query to filter on the results of the aggregation. Closes: #35639
2019-01-31 09:33:05 -05:00
-----------------------------------------------------------
["source","sql",subs="attributes,macros"]
---------------------------------------------------------------------
SQL: Spec tests now use classpath discovery (#40388) To avoid having to specify each spec by hand (which can miss specs to be added), the test infrastructure now performs classpath discovery so that each spec added, is automatically considered. Relates #40358 (cherry picked from commit d0f60b4425c731509aa8ca765d55f563f866ef90)
2019-03-25 09:22:59 -04:00
include-tagged::{sql-specs}/docs/docs.csv-spec[firstWithTwoArgsAndGroupBy]
SQL: Implement FIRST/LAST aggregate functions (#37936) FIRST and LAST can be used with one argument and work similarly to MIN and MAX but they are implemented using a Top Hits aggregation and therefore can also operate on keyword fields. When a second argument is provided then they return the first/last value of the first arg when its values are ordered ascending/descending (respectively) by the values of the second argument. Currently because of the usage of a Top Hits aggregation FIRST and LAST cannot be used in the HAVING clause of a GROUP BY query to filter on the results of the aggregation. Closes: #35639
2019-01-31 09:33:05 -05:00
---------------------------------------------------------------------
`FIRST_VALUE` is a name alias and can be used instead of `FIRST`, e.g.:
["source","sql",subs="attributes,macros"]
--------------------------------------------------------------------------
SQL: Spec tests now use classpath discovery (#40388) To avoid having to specify each spec by hand (which can miss specs to be added), the test infrastructure now performs classpath discovery so that each spec added, is automatically considered. Relates #40358 (cherry picked from commit d0f60b4425c731509aa8ca765d55f563f866ef90)
2019-03-25 09:22:59 -04:00
include-tagged::{sql-specs}/docs/docs.csv-spec[firstValueWithTwoArgsAndGroupBy]
SQL: Implement FIRST/LAST aggregate functions (#37936) FIRST and LAST can be used with one argument and work similarly to MIN and MAX but they are implemented using a Top Hits aggregation and therefore can also operate on keyword fields. When a second argument is provided then they return the first/last value of the first arg when its values are ordered ascending/descending (respectively) by the values of the second argument. Currently because of the usage of a Top Hits aggregation FIRST and LAST cannot be used in the HAVING clause of a GROUP BY query to filter on the results of the aggregation. Closes: #35639
2019-01-31 09:33:05 -05:00
--------------------------------------------------------------------------
SQL: Implement scripting inside aggs (#55241) (#55371) Implement the use of scalar functions inside aggregate functions. This allows for complex expressions inside aggregations, with or without GROUBY as well as with or without a HAVING clause. e.g.: ``` SELECT MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) AS max, b FROM test GROUP BY b HAVING MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) > 5 ``` Scalar functions are still not allowed for `KURTOSIS` and `SKEWNESS` as this is currently not implemented on the ElasticSearch side. Fixes: #29980 Fixes: #36865 Fixes: #37271 (cherry picked from commit 506d1beea7abb2b45de793bba2e349090a78f2f9)
2020-04-17 06:41:22 -04:00
["source","sql",subs="attributes,macros"]
--------------------------------------------------------------------------
include-tagged::{sql-specs}/docs/docs.csv-spec[firstValueWithTwoArgsAndGroupByScalars]
--------------------------------------------------------------------------
SQL: Implement FIRST/LAST aggregate functions (#37936) FIRST and LAST can be used with one argument and work similarly to MIN and MAX but they are implemented using a Top Hits aggregation and therefore can also operate on keyword fields. When a second argument is provided then they return the first/last value of the first arg when its values are ordered ascending/descending (respectively) by the values of the second argument. Currently because of the usage of a Top Hits aggregation FIRST and LAST cannot be used in the HAVING clause of a GROUP BY query to filter on the results of the aggregation. Closes: #35639
2019-01-31 09:33:05 -05:00
[NOTE]
`FIRST` cannot be used in a HAVING clause.
[NOTE]
`FIRST` cannot be used with columns of type <<text, `text`>> unless
the field is also <<before-enabling-fielddata,saved as a keyword>>.
[[sql-functions-aggs-last]]
SQL: MATCH and QUERY documentation; one list of functions (#40494) * Document MATCH and QUERY function predicates. * Polish the functions pages and add a list of functions to the main Functions & Operators page. (cherry picked from commit 4cec0ae1b962ec7ea011a290aec72740386eb808)
2019-03-27 11:18:14 -04:00
==== `LAST/LAST_VALUE`
SQL: Implement FIRST/LAST aggregate functions (#37936) FIRST and LAST can be used with one argument and work similarly to MIN and MAX but they are implemented using a Top Hits aggregation and therefore can also operate on keyword fields. When a second argument is provided then they return the first/last value of the first arg when its values are ordered ascending/descending (respectively) by the values of the second argument. Currently because of the usage of a Top Hits aggregation FIRST and LAST cannot be used in the HAVING clause of a GROUP BY query to filter on the results of the aggregation. Closes: #35639
2019-01-31 09:33:05 -05:00
.Synopsis:
[source, sql]
--------------------------------------------------
[DOCS] Remove inline callouts for Asciidoctor migration (#41309)
2019-04-22 09:33:55 -04:00
LAST(
field_name <1>
[, ordering_field_name]) <2>
SQL: Implement FIRST/LAST aggregate functions (#37936) FIRST and LAST can be used with one argument and work similarly to MIN and MAX but they are implemented using a Top Hits aggregation and therefore can also operate on keyword fields. When a second argument is provided then they return the first/last value of the first arg when its values are ordered ascending/descending (respectively) by the values of the second argument. Currently because of the usage of a Top Hits aggregation FIRST and LAST cannot be used in the HAVING clause of a GROUP BY query to filter on the results of the aggregation. Closes: #35639
2019-01-31 09:33:05 -05:00
--------------------------------------------------
*Input*:
<1> target field for the aggregation
<2> optional field used for ordering
*Output*: same type as the input
SQL: document the use of a filter on _routing (#52355) * Fix "Description"s for various sections in the functions pages. * Added a TIP for searching using a routing key. * Other small polishings (cherry picked from commit 9fad0b1ac4409a42c435ed040f41cbaea18930a3)
2020-02-14 11:58:45 -05:00
*Description*: It's the inverse of <<sql-functions-aggs-first>>. Returns the last **non-NULL** value (if such exists) of the
`field_name` input column sorted descending by the `ordering_field_name` column. If `ordering_field_name` is not
SQL: Implement FIRST/LAST aggregate functions (#37936) FIRST and LAST can be used with one argument and work similarly to MIN and MAX but they are implemented using a Top Hits aggregation and therefore can also operate on keyword fields. When a second argument is provided then they return the first/last value of the first arg when its values are ordered ascending/descending (respectively) by the values of the second argument. Currently because of the usage of a Top Hits aggregation FIRST and LAST cannot be used in the HAVING clause of a GROUP BY query to filter on the results of the aggregation. Closes: #35639
2019-01-31 09:33:05 -05:00
provided, only the `field_name` column is used for the sorting. E.g.:
[cols="<,<"]
|===
s| a | b
| 10 | 1
| 20 | 1
| 1 | 2
| 2 | 2
| 100 | null
| 200 | null
| null | null
|===
[source, sql]
------------------------
SELECT LAST(a) FROM t
------------------------
will result in:
[cols="<"]
|===
s| LAST(a)
| 200
|===
and
[source, sql]
------------------------
SELECT LAST(a, b) FROM t
------------------------
will result in:
[cols="<"]
|===
s| LAST(a, b)
| 2
|===
["source","sql",subs="attributes,macros"]
-----------------------------------------------------------
SQL: Spec tests now use classpath discovery (#40388) To avoid having to specify each spec by hand (which can miss specs to be added), the test infrastructure now performs classpath discovery so that each spec added, is automatically considered. Relates #40358 (cherry picked from commit d0f60b4425c731509aa8ca765d55f563f866ef90)
2019-03-25 09:22:59 -04:00
include-tagged::{sql-specs}/docs/docs.csv-spec[lastWithOneArg]
SQL: Implement FIRST/LAST aggregate functions (#37936) FIRST and LAST can be used with one argument and work similarly to MIN and MAX but they are implemented using a Top Hits aggregation and therefore can also operate on keyword fields. When a second argument is provided then they return the first/last value of the first arg when its values are ordered ascending/descending (respectively) by the values of the second argument. Currently because of the usage of a Top Hits aggregation FIRST and LAST cannot be used in the HAVING clause of a GROUP BY query to filter on the results of the aggregation. Closes: #35639
2019-01-31 09:33:05 -05:00
-----------------------------------------------------------
["source","sql",subs="attributes,macros"]
-------------------------------------------------------------------
SQL: Spec tests now use classpath discovery (#40388) To avoid having to specify each spec by hand (which can miss specs to be added), the test infrastructure now performs classpath discovery so that each spec added, is automatically considered. Relates #40358 (cherry picked from commit d0f60b4425c731509aa8ca765d55f563f866ef90)
2019-03-25 09:22:59 -04:00
include-tagged::{sql-specs}/docs/docs.csv-spec[lastWithOneArgAndGroupBy]
SQL: Implement FIRST/LAST aggregate functions (#37936) FIRST and LAST can be used with one argument and work similarly to MIN and MAX but they are implemented using a Top Hits aggregation and therefore can also operate on keyword fields. When a second argument is provided then they return the first/last value of the first arg when its values are ordered ascending/descending (respectively) by the values of the second argument. Currently because of the usage of a Top Hits aggregation FIRST and LAST cannot be used in the HAVING clause of a GROUP BY query to filter on the results of the aggregation. Closes: #35639
2019-01-31 09:33:05 -05:00
-------------------------------------------------------------------
["source","sql",subs="attributes,macros"]
-----------------------------------------------------------
SQL: Spec tests now use classpath discovery (#40388) To avoid having to specify each spec by hand (which can miss specs to be added), the test infrastructure now performs classpath discovery so that each spec added, is automatically considered. Relates #40358 (cherry picked from commit d0f60b4425c731509aa8ca765d55f563f866ef90)
2019-03-25 09:22:59 -04:00
include-tagged::{sql-specs}/docs/docs.csv-spec[lastWithTwoArgs]
SQL: Implement FIRST/LAST aggregate functions (#37936) FIRST and LAST can be used with one argument and work similarly to MIN and MAX but they are implemented using a Top Hits aggregation and therefore can also operate on keyword fields. When a second argument is provided then they return the first/last value of the first arg when its values are ordered ascending/descending (respectively) by the values of the second argument. Currently because of the usage of a Top Hits aggregation FIRST and LAST cannot be used in the HAVING clause of a GROUP BY query to filter on the results of the aggregation. Closes: #35639
2019-01-31 09:33:05 -05:00
-----------------------------------------------------------
["source","sql",subs="attributes,macros"]
--------------------------------------------------------------------
SQL: Spec tests now use classpath discovery (#40388) To avoid having to specify each spec by hand (which can miss specs to be added), the test infrastructure now performs classpath discovery so that each spec added, is automatically considered. Relates #40358 (cherry picked from commit d0f60b4425c731509aa8ca765d55f563f866ef90)
2019-03-25 09:22:59 -04:00
include-tagged::{sql-specs}/docs/docs.csv-spec[lastWithTwoArgsAndGroupBy]
SQL: Implement FIRST/LAST aggregate functions (#37936) FIRST and LAST can be used with one argument and work similarly to MIN and MAX but they are implemented using a Top Hits aggregation and therefore can also operate on keyword fields. When a second argument is provided then they return the first/last value of the first arg when its values are ordered ascending/descending (respectively) by the values of the second argument. Currently because of the usage of a Top Hits aggregation FIRST and LAST cannot be used in the HAVING clause of a GROUP BY query to filter on the results of the aggregation. Closes: #35639
2019-01-31 09:33:05 -05:00
--------------------------------------------------------------------
`LAST_VALUE` is a name alias and can be used instead of `LAST`, e.g.:
["source","sql",subs="attributes,macros"]
-------------------------------------------------------------------------
SQL: Spec tests now use classpath discovery (#40388) To avoid having to specify each spec by hand (which can miss specs to be added), the test infrastructure now performs classpath discovery so that each spec added, is automatically considered. Relates #40358 (cherry picked from commit d0f60b4425c731509aa8ca765d55f563f866ef90)
2019-03-25 09:22:59 -04:00
include-tagged::{sql-specs}/docs/docs.csv-spec[lastValueWithTwoArgsAndGroupBy]
SQL: Implement FIRST/LAST aggregate functions (#37936) FIRST and LAST can be used with one argument and work similarly to MIN and MAX but they are implemented using a Top Hits aggregation and therefore can also operate on keyword fields. When a second argument is provided then they return the first/last value of the first arg when its values are ordered ascending/descending (respectively) by the values of the second argument. Currently because of the usage of a Top Hits aggregation FIRST and LAST cannot be used in the HAVING clause of a GROUP BY query to filter on the results of the aggregation. Closes: #35639
2019-01-31 09:33:05 -05:00
-------------------------------------------------------------------------
SQL: Implement scripting inside aggs (#55241) (#55371) Implement the use of scalar functions inside aggregate functions. This allows for complex expressions inside aggregations, with or without GROUBY as well as with or without a HAVING clause. e.g.: ``` SELECT MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) AS max, b FROM test GROUP BY b HAVING MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) > 5 ``` Scalar functions are still not allowed for `KURTOSIS` and `SKEWNESS` as this is currently not implemented on the ElasticSearch side. Fixes: #29980 Fixes: #36865 Fixes: #37271 (cherry picked from commit 506d1beea7abb2b45de793bba2e349090a78f2f9)
2020-04-17 06:41:22 -04:00
["source","sql",subs="attributes,macros"]
-------------------------------------------------------------------------
include-tagged::{sql-specs}/docs/docs.csv-spec[lastValueWithTwoArgsAndGroupByScalars]
-------------------------------------------------------------------------
SQL: Implement FIRST/LAST aggregate functions (#37936) FIRST and LAST can be used with one argument and work similarly to MIN and MAX but they are implemented using a Top Hits aggregation and therefore can also operate on keyword fields. When a second argument is provided then they return the first/last value of the first arg when its values are ordered ascending/descending (respectively) by the values of the second argument. Currently because of the usage of a Top Hits aggregation FIRST and LAST cannot be used in the HAVING clause of a GROUP BY query to filter on the results of the aggregation. Closes: #35639
2019-01-31 09:33:05 -05:00
[NOTE]
`LAST` cannot be used in `HAVING` clause.
[NOTE]
`LAST` cannot be used with columns of type <<text, `text`>> unless
the field is also <<before-enabling-fielddata,`saved as a keyword`>>.
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
[[sql-functions-aggs-max]]
SQL: MATCH and QUERY documentation; one list of functions (#40494) * Document MATCH and QUERY function predicates. * Polish the functions pages and add a list of functions to the main Functions & Operators page. (cherry picked from commit 4cec0ae1b962ec7ea011a290aec72740386eb808)
2019-03-27 11:18:14 -04:00
==== `MAX`
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
.Synopsis:
[source, sql]
--------------------------------------------------
[DOCS] Remove inline callouts for Asciidoctor migration (#41309)
2019-04-22 09:33:55 -04:00
MAX(field_name) <1>
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
--------------------------------------------------
*Input*:
<1> a numeric field
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
*Output*: same type as the input
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: document the use of a filter on _routing (#52355) * Fix "Description"s for various sections in the functions pages. * Added a TIP for searching using a routing key. * Other small polishings (cherry picked from commit 9fad0b1ac4409a42c435ed040f41cbaea18930a3)
2020-02-14 11:58:45 -05:00
*Description*: Returns the maximum value across input values in the field `field_name`.
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
["source","sql",subs="attributes,macros"]
--------------------------------------------------
SQL: Spec tests now use classpath discovery (#40388) To avoid having to specify each spec by hand (which can miss specs to be added), the test infrastructure now performs classpath discovery so that each spec added, is automatically considered. Relates #40358 (cherry picked from commit d0f60b4425c731509aa8ca765d55f563f866ef90)
2019-03-25 09:22:59 -04:00
include-tagged::{sql-specs}/docs/docs.csv-spec[aggMax]
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
--------------------------------------------------
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: Implement scripting inside aggs (#55241) (#55371) Implement the use of scalar functions inside aggregate functions. This allows for complex expressions inside aggregations, with or without GROUBY as well as with or without a HAVING clause. e.g.: ``` SELECT MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) AS max, b FROM test GROUP BY b HAVING MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) > 5 ``` Scalar functions are still not allowed for `KURTOSIS` and `SKEWNESS` as this is currently not implemented on the ElasticSearch side. Fixes: #29980 Fixes: #36865 Fixes: #37271 (cherry picked from commit 506d1beea7abb2b45de793bba2e349090a78f2f9)
2020-04-17 06:41:22 -04:00
["source","sql",subs="attributes,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/docs/docs.csv-spec[aggMaxScalars]
--------------------------------------------------
SQL: Implement FIRST/LAST aggregate functions (#37936) FIRST and LAST can be used with one argument and work similarly to MIN and MAX but they are implemented using a Top Hits aggregation and therefore can also operate on keyword fields. When a second argument is provided then they return the first/last value of the first arg when its values are ordered ascending/descending (respectively) by the values of the second argument. Currently because of the usage of a Top Hits aggregation FIRST and LAST cannot be used in the HAVING clause of a GROUP BY query to filter on the results of the aggregation. Closes: #35639
2019-01-31 09:33:05 -05:00
[NOTE]
`MAX` on a field of type <<text, `text`>> or <<keyword, `keyword`>> is translated into
<<sql-functions-aggs-last>> and therefore, it cannot be used in `HAVING` clause.
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
[[sql-functions-aggs-min]]
SQL: MATCH and QUERY documentation; one list of functions (#40494) * Document MATCH and QUERY function predicates. * Polish the functions pages and add a list of functions to the main Functions & Operators page. (cherry picked from commit 4cec0ae1b962ec7ea011a290aec72740386eb808)
2019-03-27 11:18:14 -04:00
==== `MIN`
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
.Synopsis:
[source, sql]
--------------------------------------------------
[DOCS] Remove inline callouts for Asciidoctor migration (#41309)
2019-04-22 09:33:55 -04:00
MIN(field_name) <1>
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
--------------------------------------------------
*Input*:
<1> a numeric field
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
*Output*: same type as the input
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: document the use of a filter on _routing (#52355) * Fix "Description"s for various sections in the functions pages. * Added a TIP for searching using a routing key. * Other small polishings (cherry picked from commit 9fad0b1ac4409a42c435ed040f41cbaea18930a3)
2020-02-14 11:58:45 -05:00
*Description*: Returns the minimum value across input values in the field `field_name`.
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
["source","sql",subs="attributes,macros"]
--------------------------------------------------
SQL: Spec tests now use classpath discovery (#40388) To avoid having to specify each spec by hand (which can miss specs to be added), the test infrastructure now performs classpath discovery so that each spec added, is automatically considered. Relates #40358 (cherry picked from commit d0f60b4425c731509aa8ca765d55f563f866ef90)
2019-03-25 09:22:59 -04:00
include-tagged::{sql-specs}/docs/docs.csv-spec[aggMin]
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
--------------------------------------------------
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: Implement FIRST/LAST aggregate functions (#37936) FIRST and LAST can be used with one argument and work similarly to MIN and MAX but they are implemented using a Top Hits aggregation and therefore can also operate on keyword fields. When a second argument is provided then they return the first/last value of the first arg when its values are ordered ascending/descending (respectively) by the values of the second argument. Currently because of the usage of a Top Hits aggregation FIRST and LAST cannot be used in the HAVING clause of a GROUP BY query to filter on the results of the aggregation. Closes: #35639
2019-01-31 09:33:05 -05:00
[NOTE]
`MIN` on a field of type <<text, `text`>> or <<keyword, `keyword`>> is translated into
<<sql-functions-aggs-first>> and therefore, it cannot be used in `HAVING` clause.
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
[[sql-functions-aggs-sum]]
SQL: MATCH and QUERY documentation; one list of functions (#40494) * Document MATCH and QUERY function predicates. * Polish the functions pages and add a list of functions to the main Functions & Operators page. (cherry picked from commit 4cec0ae1b962ec7ea011a290aec72740386eb808)
2019-03-27 11:18:14 -04:00
==== `SUM`
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
.Synopsis:
[source, sql]
--------------------------------------------------
[DOCS] Remove inline callouts for Asciidoctor migration (#41309)
2019-04-22 09:33:55 -04:00
SUM(field_name) <1>
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
--------------------------------------------------
*Input*:
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
<1> a numeric field
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
*Output*: `bigint` for integer input, `double` for floating points
SQL: document the use of a filter on _routing (#52355) * Fix "Description"s for various sections in the functions pages. * Added a TIP for searching using a routing key. * Other small polishings (cherry picked from commit 9fad0b1ac4409a42c435ed040f41cbaea18930a3)
2020-02-14 11:58:45 -05:00
*Description*: Returns the sum of input values in the field `field_name`.
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
["source","sql",subs="attributes,macros"]
--------------------------------------------------
SQL: Spec tests now use classpath discovery (#40388) To avoid having to specify each spec by hand (which can miss specs to be added), the test infrastructure now performs classpath discovery so that each spec added, is automatically considered. Relates #40358 (cherry picked from commit d0f60b4425c731509aa8ca765d55f563f866ef90)
2019-03-25 09:22:59 -04:00
include-tagged::{sql-specs}/docs/docs.csv-spec[aggSum]
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
--------------------------------------------------
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: Implement scripting inside aggs (#55241) (#55371) Implement the use of scalar functions inside aggregate functions. This allows for complex expressions inside aggregations, with or without GROUBY as well as with or without a HAVING clause. e.g.: ``` SELECT MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) AS max, b FROM test GROUP BY b HAVING MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) > 5 ``` Scalar functions are still not allowed for `KURTOSIS` and `SKEWNESS` as this is currently not implemented on the ElasticSearch side. Fixes: #29980 Fixes: #36865 Fixes: #37271 (cherry picked from commit 506d1beea7abb2b45de793bba2e349090a78f2f9)
2020-04-17 06:41:22 -04:00
["source","sql",subs="attributes,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/docs/docs.csv-spec[aggSumScalars]
--------------------------------------------------
SQL: MATCH and QUERY documentation; one list of functions (#40494) * Document MATCH and QUERY function predicates. * Polish the functions pages and add a list of functions to the main Functions & Operators page. (cherry picked from commit 4cec0ae1b962ec7ea011a290aec72740386eb808)
2019-03-27 11:18:14 -04:00
[[sql-functions-aggs-statistics]]
[DOCS] Swap `[float]` for `[discrete]` (#60134) Changes instances of `[float]` in our docs for `[discrete]`. Asciidoctor prefers the `[discrete]` tag for floating headings: https://asciidoctor.org/docs/asciidoc-asciidoctor-diffs/#blocks
2020-07-23 12:42:33 -04:00
[discrete]
SQL: MATCH and QUERY documentation; one list of functions (#40494) * Document MATCH and QUERY function predicates. * Polish the functions pages and add a list of functions to the main Functions & Operators page. (cherry picked from commit 4cec0ae1b962ec7ea011a290aec72740386eb808)
2019-03-27 11:18:14 -04:00
=== Statistics
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
[[sql-functions-aggs-kurtosis]]
SQL: MATCH and QUERY documentation; one list of functions (#40494) * Document MATCH and QUERY function predicates. * Polish the functions pages and add a list of functions to the main Functions & Operators page. (cherry picked from commit 4cec0ae1b962ec7ea011a290aec72740386eb808)
2019-03-27 11:18:14 -04:00
==== `KURTOSIS`
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
.Synopsis:
[source, sql]
--------------------------------------------------
[DOCS] Remove inline callouts for Asciidoctor migration (#41309)
2019-04-22 09:33:55 -04:00
KURTOSIS(field_name) <1>
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
--------------------------------------------------
*Input*:
<1> a numeric field
*Output*: `double` numeric value
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: document the use of a filter on _routing (#52355) * Fix "Description"s for various sections in the functions pages. * Added a TIP for searching using a routing key. * Other small polishings (cherry picked from commit 9fad0b1ac4409a42c435ed040f41cbaea18930a3)
2020-02-14 11:58:45 -05:00
*Description*:
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
https://en.wikipedia.org/wiki/Kurtosis[Quantify] the shape of the distribution of input values in the field `field_name`.
["source","sql",subs="attributes,macros"]
--------------------------------------------------
SQL: Spec tests now use classpath discovery (#40388) To avoid having to specify each spec by hand (which can miss specs to be added), the test infrastructure now performs classpath discovery so that each spec added, is automatically considered. Relates #40358 (cherry picked from commit d0f60b4425c731509aa8ca765d55f563f866ef90)
2019-03-25 09:22:59 -04:00
include-tagged::{sql-specs}/docs/docs.csv-spec[aggKurtosis]
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
--------------------------------------------------
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: Implement scripting inside aggs (#55241) (#55371) Implement the use of scalar functions inside aggregate functions. This allows for complex expressions inside aggregations, with or without GROUBY as well as with or without a HAVING clause. e.g.: ``` SELECT MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) AS max, b FROM test GROUP BY b HAVING MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) > 5 ``` Scalar functions are still not allowed for `KURTOSIS` and `SKEWNESS` as this is currently not implemented on the ElasticSearch side. Fixes: #29980 Fixes: #36865 Fixes: #37271 (cherry picked from commit 506d1beea7abb2b45de793bba2e349090a78f2f9)
2020-04-17 06:41:22 -04:00
[NOTE]
====
`KURTOSIS` cannot be used on top of scalar functions or operators but only directly on a field. So, for example,
the following is not allowed and an error is returned:
[source, sql]
---------------------------------------
SELECT KURTOSIS(salary / 12.0), gender FROM emp GROUP BY gender
---------------------------------------
====
SQL: Introduce MAD (MedianAbsoluteDeviation) aggregation (#40048) Add Median Absolute Deviation aggregation Fix #39597 (cherry picked from commit 4f09613942a9249d06c74da64ad7e6f362e97f56)
2019-03-15 05:45:10 -04:00
[[sql-functions-aggs-mad]]
SQL: MATCH and QUERY documentation; one list of functions (#40494) * Document MATCH and QUERY function predicates. * Polish the functions pages and add a list of functions to the main Functions & Operators page. (cherry picked from commit 4cec0ae1b962ec7ea011a290aec72740386eb808)
2019-03-27 11:18:14 -04:00
==== `MAD`
SQL: Introduce MAD (MedianAbsoluteDeviation) aggregation (#40048) Add Median Absolute Deviation aggregation Fix #39597 (cherry picked from commit 4f09613942a9249d06c74da64ad7e6f362e97f56)
2019-03-15 05:45:10 -04:00
.Synopsis:
[source, sql]
--------------------------------------------------
[DOCS] Remove inline callouts for Asciidoctor migration (#41309)
2019-04-22 09:33:55 -04:00
MAD(field_name) <1>
SQL: Introduce MAD (MedianAbsoluteDeviation) aggregation (#40048) Add Median Absolute Deviation aggregation Fix #39597 (cherry picked from commit 4f09613942a9249d06c74da64ad7e6f362e97f56)
2019-03-15 05:45:10 -04:00
--------------------------------------------------
*Input*:
<1> a numeric field
*Output*: `double` numeric value
SQL: document the use of a filter on _routing (#52355) * Fix "Description"s for various sections in the functions pages. * Added a TIP for searching using a routing key. * Other small polishings (cherry picked from commit 9fad0b1ac4409a42c435ed040f41cbaea18930a3)
2020-02-14 11:58:45 -05:00
*Description*:
SQL: Introduce MAD (MedianAbsoluteDeviation) aggregation (#40048) Add Median Absolute Deviation aggregation Fix #39597 (cherry picked from commit 4f09613942a9249d06c74da64ad7e6f362e97f56)
2019-03-15 05:45:10 -04:00
https://en.wikipedia.org/wiki/Median_absolute_deviation[Measure] the variability of the input values in the field `field_name`.
["source","sql",subs="attributes,macros"]
--------------------------------------------------
SQL: Spec tests now use classpath discovery (#40388) To avoid having to specify each spec by hand (which can miss specs to be added), the test infrastructure now performs classpath discovery so that each spec added, is automatically considered. Relates #40358 (cherry picked from commit d0f60b4425c731509aa8ca765d55f563f866ef90)
2019-03-25 09:22:59 -04:00
include-tagged::{sql-specs}/docs/docs.csv-spec[aggMad]
SQL: Introduce MAD (MedianAbsoluteDeviation) aggregation (#40048) Add Median Absolute Deviation aggregation Fix #39597 (cherry picked from commit 4f09613942a9249d06c74da64ad7e6f362e97f56)
2019-03-15 05:45:10 -04:00
--------------------------------------------------
SQL: Implement scripting inside aggs (#55241) (#55371) Implement the use of scalar functions inside aggregate functions. This allows for complex expressions inside aggregations, with or without GROUBY as well as with or without a HAVING clause. e.g.: ``` SELECT MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) AS max, b FROM test GROUP BY b HAVING MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) > 5 ``` Scalar functions are still not allowed for `KURTOSIS` and `SKEWNESS` as this is currently not implemented on the ElasticSearch side. Fixes: #29980 Fixes: #36865 Fixes: #37271 (cherry picked from commit 506d1beea7abb2b45de793bba2e349090a78f2f9)
2020-04-17 06:41:22 -04:00
["source","sql",subs="attributes,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/docs/docs.csv-spec[aggMadScalars]
--------------------------------------------------
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
[[sql-functions-aggs-percentile]]
SQL: MATCH and QUERY documentation; one list of functions (#40494) * Document MATCH and QUERY function predicates. * Polish the functions pages and add a list of functions to the main Functions & Operators page. (cherry picked from commit 4cec0ae1b962ec7ea011a290aec72740386eb808)
2019-03-27 11:18:14 -04:00
==== `PERCENTILE`
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
.Synopsis:
[source, sql]
--------------------------------------------------
[DOCS] Remove inline callouts for Asciidoctor migration (#41309)
2019-04-22 09:33:55 -04:00
PERCENTILE(
field_name, <1>
numeric_exp) <2>
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
--------------------------------------------------
*Input*:
<1> a numeric field
SQL: Enhance message for PERCENTILE[_RANK] with field as 2nd arg (#36933) Enhance error message for the case that the 2nd argument of PERCENTILE and PERCENTILE_RANK is not a foldable, as it doesn't make sense to have a dynamic value coming from a field. Fixes: #36903
2019-01-03 06:55:09 -05:00
<2> a numeric expression (must be a constant and not based on a field)
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
*Output*: `double` numeric value
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: document the use of a filter on _routing (#52355) * Fix "Description"s for various sections in the functions pages. * Added a TIP for searching using a routing key. * Other small polishings (cherry picked from commit 9fad0b1ac4409a42c435ed040f41cbaea18930a3)
2020-02-14 11:58:45 -05:00
*Description*:
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
Returns the nth https://en.wikipedia.org/wiki/Percentile[percentile] (represented by `numeric_exp` parameter)
of input values in the field `field_name`.
["source","sql",subs="attributes,macros"]
--------------------------------------------------
SQL: Spec tests now use classpath discovery (#40388) To avoid having to specify each spec by hand (which can miss specs to be added), the test infrastructure now performs classpath discovery so that each spec added, is automatically considered. Relates #40358 (cherry picked from commit d0f60b4425c731509aa8ca765d55f563f866ef90)
2019-03-25 09:22:59 -04:00
include-tagged::{sql-specs}/docs/docs.csv-spec[aggPercentile]
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
--------------------------------------------------
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: Implement scripting inside aggs (#55241) (#55371) Implement the use of scalar functions inside aggregate functions. This allows for complex expressions inside aggregations, with or without GROUBY as well as with or without a HAVING clause. e.g.: ``` SELECT MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) AS max, b FROM test GROUP BY b HAVING MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) > 5 ``` Scalar functions are still not allowed for `KURTOSIS` and `SKEWNESS` as this is currently not implemented on the ElasticSearch side. Fixes: #29980 Fixes: #36865 Fixes: #37271 (cherry picked from commit 506d1beea7abb2b45de793bba2e349090a78f2f9)
2020-04-17 06:41:22 -04:00
["source","sql",subs="attributes,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/docs/docs.csv-spec[aggPercentileScalars]
--------------------------------------------------
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
[[sql-functions-aggs-percentile-rank]]
SQL: MATCH and QUERY documentation; one list of functions (#40494) * Document MATCH and QUERY function predicates. * Polish the functions pages and add a list of functions to the main Functions & Operators page. (cherry picked from commit 4cec0ae1b962ec7ea011a290aec72740386eb808)
2019-03-27 11:18:14 -04:00
==== `PERCENTILE_RANK`
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
.Synopsis:
[source, sql]
--------------------------------------------------
[DOCS] Remove inline callouts for Asciidoctor migration (#41309)
2019-04-22 09:33:55 -04:00
PERCENTILE_RANK(
field_name, <1>
numeric_exp) <2>
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
--------------------------------------------------
*Input*:
<1> a numeric field
SQL: Enhance message for PERCENTILE[_RANK] with field as 2nd arg (#36933) Enhance error message for the case that the 2nd argument of PERCENTILE and PERCENTILE_RANK is not a foldable, as it doesn't make sense to have a dynamic value coming from a field. Fixes: #36903
2019-01-03 06:55:09 -05:00
<2> a numeric expression (must be a constant and not based on a field)
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
*Output*: `double` numeric value
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: document the use of a filter on _routing (#52355) * Fix "Description"s for various sections in the functions pages. * Added a TIP for searching using a routing key. * Other small polishings (cherry picked from commit 9fad0b1ac4409a42c435ed040f41cbaea18930a3)
2020-02-14 11:58:45 -05:00
*Description*:
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
Returns the nth https://en.wikipedia.org/wiki/Percentile_rank[percentile rank] (represented by `numeric_exp` parameter)
of input values in the field `field_name`.
["source","sql",subs="attributes,macros"]
--------------------------------------------------
SQL: Spec tests now use classpath discovery (#40388) To avoid having to specify each spec by hand (which can miss specs to be added), the test infrastructure now performs classpath discovery so that each spec added, is automatically considered. Relates #40358 (cherry picked from commit d0f60b4425c731509aa8ca765d55f563f866ef90)
2019-03-25 09:22:59 -04:00
include-tagged::{sql-specs}/docs/docs.csv-spec[aggPercentileRank]
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
--------------------------------------------------
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: Implement scripting inside aggs (#55241) (#55371) Implement the use of scalar functions inside aggregate functions. This allows for complex expressions inside aggregations, with or without GROUBY as well as with or without a HAVING clause. e.g.: ``` SELECT MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) AS max, b FROM test GROUP BY b HAVING MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) > 5 ``` Scalar functions are still not allowed for `KURTOSIS` and `SKEWNESS` as this is currently not implemented on the ElasticSearch side. Fixes: #29980 Fixes: #36865 Fixes: #37271 (cherry picked from commit 506d1beea7abb2b45de793bba2e349090a78f2f9)
2020-04-17 06:41:22 -04:00
["source","sql",subs="attributes,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/docs/docs.csv-spec[aggPercentileRankScalars]
--------------------------------------------------
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
[[sql-functions-aggs-skewness]]
SQL: MATCH and QUERY documentation; one list of functions (#40494) * Document MATCH and QUERY function predicates. * Polish the functions pages and add a list of functions to the main Functions & Operators page. (cherry picked from commit 4cec0ae1b962ec7ea011a290aec72740386eb808)
2019-03-27 11:18:14 -04:00
==== `SKEWNESS`
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
.Synopsis:
[source, sql]
--------------------------------------------------
[DOCS] Remove inline callouts for Asciidoctor migration (#41309)
2019-04-22 09:33:55 -04:00
SKEWNESS(field_name) <1>
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
--------------------------------------------------
*Input*:
<1> a numeric field
*Output*: `double` numeric value
SQL: document the use of a filter on _routing (#52355) * Fix "Description"s for various sections in the functions pages. * Added a TIP for searching using a routing key. * Other small polishings (cherry picked from commit 9fad0b1ac4409a42c435ed040f41cbaea18930a3)
2020-02-14 11:58:45 -05:00
*Description*:
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
https://en.wikipedia.org/wiki/Skewness[Quantify] the asymmetric distribution of input values in the field `field_name`.
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
["source","sql",subs="attributes,macros"]
--------------------------------------------------
SQL: Spec tests now use classpath discovery (#40388) To avoid having to specify each spec by hand (which can miss specs to be added), the test infrastructure now performs classpath discovery so that each spec added, is automatically considered. Relates #40358 (cherry picked from commit d0f60b4425c731509aa8ca765d55f563f866ef90)
2019-03-25 09:22:59 -04:00
include-tagged::{sql-specs}/docs/docs.csv-spec[aggSkewness]
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
--------------------------------------------------
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: Implement scripting inside aggs (#55241) (#55371) Implement the use of scalar functions inside aggregate functions. This allows for complex expressions inside aggregations, with or without GROUBY as well as with or without a HAVING clause. e.g.: ``` SELECT MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) AS max, b FROM test GROUP BY b HAVING MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) > 5 ``` Scalar functions are still not allowed for `KURTOSIS` and `SKEWNESS` as this is currently not implemented on the ElasticSearch side. Fixes: #29980 Fixes: #36865 Fixes: #37271 (cherry picked from commit 506d1beea7abb2b45de793bba2e349090a78f2f9)
2020-04-17 06:41:22 -04:00
[NOTE]
====
`SKEWNESS` cannot be used on top of scalar functions but only directly on a field. So, for example, the following is
not allowed and an error is returned:
[source, sql]
---------------------------------------
SELECT SKEWNESS(ROUND(salary / 12.0, 2), gender FROM emp GROUP BY gender
---------------------------------------
====
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
[[sql-functions-aggs-stddev-pop]]
SQL: MATCH and QUERY documentation; one list of functions (#40494) * Document MATCH and QUERY function predicates. * Polish the functions pages and add a list of functions to the main Functions & Operators page. (cherry picked from commit 4cec0ae1b962ec7ea011a290aec72740386eb808)
2019-03-27 11:18:14 -04:00
==== `STDDEV_POP`
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
.Synopsis:
[source, sql]
--------------------------------------------------
[DOCS] Remove inline callouts for Asciidoctor migration (#41309)
2019-04-22 09:33:55 -04:00
STDDEV_POP(field_name) <1>
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
--------------------------------------------------
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
*Input*:
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
<1> a numeric field
*Output*: `double` numeric value
SQL: document the use of a filter on _routing (#52355) * Fix "Description"s for various sections in the functions pages. * Added a TIP for searching using a routing key. * Other small polishings (cherry picked from commit 9fad0b1ac4409a42c435ed040f41cbaea18930a3)
2020-02-14 11:58:45 -05:00
*Description*:
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
Returns the https://en.wikipedia.org/wiki/Standard_deviations[population standard deviation] of input values in the field `field_name`.
["source","sql",subs="attributes,macros"]
--------------------------------------------------
SQL: Spec tests now use classpath discovery (#40388) To avoid having to specify each spec by hand (which can miss specs to be added), the test infrastructure now performs classpath discovery so that each spec added, is automatically considered. Relates #40358 (cherry picked from commit d0f60b4425c731509aa8ca765d55f563f866ef90)
2019-03-25 09:22:59 -04:00
include-tagged::{sql-specs}/docs/docs.csv-spec[aggStddevPop]
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
--------------------------------------------------
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: Implement scripting inside aggs (#55241) (#55371) Implement the use of scalar functions inside aggregate functions. This allows for complex expressions inside aggregations, with or without GROUBY as well as with or without a HAVING clause. e.g.: ``` SELECT MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) AS max, b FROM test GROUP BY b HAVING MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) > 5 ``` Scalar functions are still not allowed for `KURTOSIS` and `SKEWNESS` as this is currently not implemented on the ElasticSearch side. Fixes: #29980 Fixes: #36865 Fixes: #37271 (cherry picked from commit 506d1beea7abb2b45de793bba2e349090a78f2f9)
2020-04-17 06:41:22 -04:00
["source","sql",subs="attributes,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/docs/docs.csv-spec[aggStddevPopScalars]
--------------------------------------------------
Add sample versions of standard deviation and variance funcs (#59093) (#59274) * Add sample versions of standard deviation and variance functions (#59093) * Add STDDEV_SAMP, VAR_SAMP This commit adds the sampling variations of the standard deviation and variance agg functions. (cherry picked from commit 8b29817b49e386215f29cb5b3356d0183fd5d9de) * Fix: workaround for lack of Map#of() in Java8 Replace Map#of() with a HashMap static init.
2020-07-09 04:17:13 -04:00
[[sql-functions-aggs-stddev-samp]]
==== `STDDEV_SAMP`
.Synopsis:
[source, sql]
--------------------------------------------------
STDDEV_SAMP(field_name) <1>
--------------------------------------------------
*Input*:
<1> a numeric field
*Output*: `double` numeric value
*Description*:
Returns the https://en.wikipedia.org/wiki/Standard_deviations[sample standard deviation] of input values in the field `field_name`.
["source","sql",subs="attributes,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/docs/docs.csv-spec[aggStddevSamp]
--------------------------------------------------
["source","sql",subs="attributes,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/docs/docs.csv-spec[aggStddevSampScalars]
--------------------------------------------------
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
[[sql-functions-aggs-sum-squares]]
SQL: MATCH and QUERY documentation; one list of functions (#40494) * Document MATCH and QUERY function predicates. * Polish the functions pages and add a list of functions to the main Functions & Operators page. (cherry picked from commit 4cec0ae1b962ec7ea011a290aec72740386eb808)
2019-03-27 11:18:14 -04:00
==== `SUM_OF_SQUARES`
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
.Synopsis:
[source, sql]
--------------------------------------------------
[DOCS] Remove inline callouts for Asciidoctor migration (#41309)
2019-04-22 09:33:55 -04:00
SUM_OF_SQUARES(field_name) <1>
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
--------------------------------------------------
*Input*:
<1> a numeric field
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
*Output*: `double` numeric value
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: document the use of a filter on _routing (#52355) * Fix "Description"s for various sections in the functions pages. * Added a TIP for searching using a routing key. * Other small polishings (cherry picked from commit 9fad0b1ac4409a42c435ed040f41cbaea18930a3)
2020-02-14 11:58:45 -05:00
*Description*:
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
[DOCS] Remove Wikipedia link from `SUM_OF_SQUARES` SQL function docs (#52398) Removed the link to Wikipedia as the function is not calculating the sum of squares in this way. More can be found here at this issue: https://github.com/elastic/elasticsearch/issues/50416
2020-04-20 09:58:30 -04:00
Returns the sum of squares of input values in the field `field_name`.
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
["source","sql",subs="attributes,macros"]
--------------------------------------------------
SQL: Spec tests now use classpath discovery (#40388) To avoid having to specify each spec by hand (which can miss specs to be added), the test infrastructure now performs classpath discovery so that each spec added, is automatically considered. Relates #40358 (cherry picked from commit d0f60b4425c731509aa8ca765d55f563f866ef90)
2019-03-25 09:22:59 -04:00
include-tagged::{sql-specs}/docs/docs.csv-spec[aggSumOfSquares]
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
--------------------------------------------------
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: Implement scripting inside aggs (#55241) (#55371) Implement the use of scalar functions inside aggregate functions. This allows for complex expressions inside aggregations, with or without GROUBY as well as with or without a HAVING clause. e.g.: ``` SELECT MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) AS max, b FROM test GROUP BY b HAVING MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) > 5 ``` Scalar functions are still not allowed for `KURTOSIS` and `SKEWNESS` as this is currently not implemented on the ElasticSearch side. Fixes: #29980 Fixes: #36865 Fixes: #37271 (cherry picked from commit 506d1beea7abb2b45de793bba2e349090a78f2f9)
2020-04-17 06:41:22 -04:00
["source","sql",subs="attributes,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/docs/docs.csv-spec[aggSumOfSquaresScalars]
--------------------------------------------------
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
[[sql-functions-aggs-var-pop]]
SQL: MATCH and QUERY documentation; one list of functions (#40494) * Document MATCH and QUERY function predicates. * Polish the functions pages and add a list of functions to the main Functions & Operators page. (cherry picked from commit 4cec0ae1b962ec7ea011a290aec72740386eb808)
2019-03-27 11:18:14 -04:00
==== `VAR_POP`
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
.Synopsis:
[source, sql]
--------------------------------------------------
[DOCS] Remove inline callouts for Asciidoctor migration (#41309)
2019-04-22 09:33:55 -04:00
VAR_POP(field_name) <1>
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
--------------------------------------------------
*Input*:
<1> a numeric field
*Output*: `double` numeric value
SQL: document the use of a filter on _routing (#52355) * Fix "Description"s for various sections in the functions pages. * Added a TIP for searching using a routing key. * Other small polishings (cherry picked from commit 9fad0b1ac4409a42c435ed040f41cbaea18930a3)
2020-02-14 11:58:45 -05:00
*Description*:
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
Returns the https://en.wikipedia.org/wiki/Variance[population variance] of input values in the field `field_name`.
DOC: Enhance SQL Functions documentation Split function section into multiple chapters Add String functions Add (small) section on Conversion/Cast functions Add missing aggregation functions Enable documentation testing (was disabled by accident). While at it, fix failing tests Improve spec tests to allow multi-line queries (useful for docs) Add ability to ignore a spec test (name should end with -Ignore)
2018-09-05 18:19:49 -04:00
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
["source","sql",subs="attributes,macros"]
--------------------------------------------------
SQL: Spec tests now use classpath discovery (#40388) To avoid having to specify each spec by hand (which can miss specs to be added), the test infrastructure now performs classpath discovery so that each spec added, is automatically considered. Relates #40358 (cherry picked from commit d0f60b4425c731509aa8ca765d55f563f866ef90)
2019-03-25 09:22:59 -04:00
include-tagged::{sql-specs}/docs/docs.csv-spec[aggVarPop]
SQL: documentation improvements and updates (#36918) * Added Limitations page * Made the aggregations page follow the common template for functions * Modified all tables to have the first row's cells content centered * Polishing in other various sections
2018-12-21 16:25:54 -05:00
--------------------------------------------------
SQL: Implement scripting inside aggs (#55241) (#55371) Implement the use of scalar functions inside aggregate functions. This allows for complex expressions inside aggregations, with or without GROUBY as well as with or without a HAVING clause. e.g.: ``` SELECT MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) AS max, b FROM test GROUP BY b HAVING MAX(CASE WHEN a IS NULL then -1 ELSE abs(a * 10) + 1 END) > 5 ``` Scalar functions are still not allowed for `KURTOSIS` and `SKEWNESS` as this is currently not implemented on the ElasticSearch side. Fixes: #29980 Fixes: #36865 Fixes: #37271 (cherry picked from commit 506d1beea7abb2b45de793bba2e349090a78f2f9)
2020-04-17 06:41:22 -04:00
["source","sql",subs="attributes,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/docs/docs.csv-spec[aggVarPopScalars]
--------------------------------------------------
Add sample versions of standard deviation and variance funcs (#59093) (#59274) * Add sample versions of standard deviation and variance functions (#59093) * Add STDDEV_SAMP, VAR_SAMP This commit adds the sampling variations of the standard deviation and variance agg functions. (cherry picked from commit 8b29817b49e386215f29cb5b3356d0183fd5d9de) * Fix: workaround for lack of Map#of() in Java8 Replace Map#of() with a HashMap static init.
2020-07-09 04:17:13 -04:00
[[sql-functions-aggs-var-samp]]
==== `VAR_SAMP`
.Synopsis:
[source, sql]
--------------------------------------------------
VAR_SAMP(field_name) <1>
--------------------------------------------------
*Input*:
<1> a numeric field
*Output*: `double` numeric value
*Description*:
Returns the https://en.wikipedia.org/wiki/Variance[sample variance] of input values in the field `field_name`.
["source","sql",subs="attributes,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/docs/docs.csv-spec[aggVarSamp]
--------------------------------------------------
["source","sql",subs="attributes,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/docs/docs.csv-spec[aggVarSampScalars]
--------------------------------------------------