honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/x-pack/docs/en/sql/functions/index.asciidoc

376 lines
13 KiB
Plaintext
Raw Normal View History

Revert "Revert "Merge branch 'feature/sql'"" This reverts commit elastic/x-pack-elasticsearch@cc79e199112db85b08a6e0682b123bb2a82445e8. We'll merge this when we're good and ready. Original commit: elastic/x-pack-elasticsearch@b3ef4f2836eda281bce7c3c2c1730933d868efa9
2017-12-13 10:19:31 -05:00
[[sql-functions]]
== Functions and Operators
SQL: Document a few functions (elastic/x-pack-elasticsearch#3390) * Starts to build the list of supported functions, adding links to wikipedia when there is any doubt what the functions mean. * Extracts an example of using the function from the test suite. * Explicitly calls out how we round (half up) because there are lots of ways to round. Original commit: elastic/x-pack-elasticsearch@5fb64ba869c796bd3883a9c8311fac4e6e5382a7
2017-12-20 17:42:29 -05:00
=== Comparison Operators
Elasticsearch SQL supports the following comparison operators:
* Equality (`=`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/filter.sql-spec[whereFieldEquality]
--------------------------------------------------
* Inequality (`<>` or `!=`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/filter.sql-spec[whereFieldNonEquality]
--------------------------------------------------
* Comparison (`<`, `<=`, `>`, `>=`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/filter.sql-spec[whereFieldLessThan]
--------------------------------------------------
* `BETWEEN`
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/filter.sql-spec[whereBetween]
--------------------------------------------------
* `IS NULL`/`IS NOT NULL`
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/filter.sql-spec[whereIsNotNullAndIsNull]
--------------------------------------------------
=== Logical Operators
Elasticsearch SQL supports the following logical operators:
* `AND`
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/filter.sql-spec[whereFieldAndComparison]
--------------------------------------------------
* `OR`
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/filter.sql-spec[whereFieldOrComparison]
--------------------------------------------------
* `NOT`
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/filter.sql-spec[whereFieldEqualityNot]
--------------------------------------------------
=== Math Operators
Elasticsearch SQL supports the following math operators:
* Add (`+`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/arithmetic.sql-spec[plus]
--------------------------------------------------
* Subtract (infix `-`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/arithmetic.sql-spec[minus]
--------------------------------------------------
* Negate (unary `-`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/arithmetic.sql-spec[unaryMinus]
--------------------------------------------------
* Multiply (`*`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/arithmetic.sql-spec[multiply]
--------------------------------------------------
* Divide (`/`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/arithmetic.sql-spec[divide]
--------------------------------------------------
* https://en.wikipedia.org/wiki/Modulo_operation[Modulo] (`%`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/arithmetic.sql-spec[mod]
--------------------------------------------------
=== Math Functions
==== Basic
* https://en.wikipedia.org/wiki/Absolute_value[Absolute value] (`ABS`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/math.sql-spec[abs]
--------------------------------------------------
* https://en.wikipedia.org/wiki/Rounding#Round_half_up[Round] (`ROUND`)
SQL: Comment out TODOs in docs That way we don't render them to users. We already are tracking them in issue elastic/x-pack-elasticsearch#2898. Original commit: elastic/x-pack-elasticsearch@de506faad06dfe7a7df6e0a593a47e9cd7065195
2018-02-02 11:06:35 -05:00
// TODO make the example in the tests presentable
SQL: Document a few functions (elastic/x-pack-elasticsearch#3390) * Starts to build the list of supported functions, adding links to wikipedia when there is any doubt what the functions mean. * Extracts an example of using the function from the test suite. * Explicitly calls out how we round (half up) because there are lots of ways to round. Original commit: elastic/x-pack-elasticsearch@5fb64ba869c796bd3883a9c8311fac4e6e5382a7
2017-12-20 17:42:29 -05:00
NOTE: This rounds "half up" meaning that `ROUND(-1.5)` results in `-1`.
* https://en.wikipedia.org/wiki/Floor_and_ceiling_functions[Ceiling] (`CEIL`)
SQL: Comment out TODOs in docs That way we don't render them to users. We already are tracking them in issue elastic/x-pack-elasticsearch#2898. Original commit: elastic/x-pack-elasticsearch@de506faad06dfe7a7df6e0a593a47e9cd7065195
2018-02-02 11:06:35 -05:00
// TODO make the example in the tests presentable
SQL: Document a few functions (elastic/x-pack-elasticsearch#3390) * Starts to build the list of supported functions, adding links to wikipedia when there is any doubt what the functions mean. * Extracts an example of using the function from the test suite. * Explicitly calls out how we round (half up) because there are lots of ways to round. Original commit: elastic/x-pack-elasticsearch@5fb64ba869c796bd3883a9c8311fac4e6e5382a7
2017-12-20 17:42:29 -05:00
* https://en.wikipedia.org/wiki/Floor_and_ceiling_functions[Floor] (`FLOOR`)
SQL: Comment out TODOs in docs That way we don't render them to users. We already are tracking them in issue elastic/x-pack-elasticsearch#2898. Original commit: elastic/x-pack-elasticsearch@de506faad06dfe7a7df6e0a593a47e9cd7065195
2018-02-02 11:06:35 -05:00
// TODO make the example in the tests presentable
SQL: Document a few functions (elastic/x-pack-elasticsearch#3390) * Starts to build the list of supported functions, adding links to wikipedia when there is any doubt what the functions mean. * Extracts an example of using the function from the test suite. * Explicitly calls out how we round (half up) because there are lots of ways to round. Original commit: elastic/x-pack-elasticsearch@5fb64ba869c796bd3883a9c8311fac4e6e5382a7
2017-12-20 17:42:29 -05:00
* https://en.wikipedia.org/wiki/Natural_logarithm[Natural logarithm] (`LOG`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/math.sql-spec[log]
--------------------------------------------------
* https://en.wikipedia.org/wiki/Logarithm[Logarithm] base 10 (`LOG10`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/math.sql-spec[log10]
--------------------------------------------------
* https://en.wikipedia.org/wiki/Square_root[Square root] (`SQRT`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/math.sql-spec[sqrt]
--------------------------------------------------
* https://en.wikipedia.org/wiki/Cube_root[Cube root] (`CBRT`)
SQL: Comment out TODOs in docs That way we don't render them to users. We already are tracking them in issue elastic/x-pack-elasticsearch#2898. Original commit: elastic/x-pack-elasticsearch@de506faad06dfe7a7df6e0a593a47e9cd7065195
2018-02-02 11:06:35 -05:00
// TODO make the example in the tests presentable
SQL: Document a few functions (elastic/x-pack-elasticsearch#3390) * Starts to build the list of supported functions, adding links to wikipedia when there is any doubt what the functions mean. * Extracts an example of using the function from the test suite. * Explicitly calls out how we round (half up) because there are lots of ways to round. Original commit: elastic/x-pack-elasticsearch@5fb64ba869c796bd3883a9c8311fac4e6e5382a7
2017-12-20 17:42:29 -05:00
* https://en.wikipedia.org/wiki/Exponential_function[e^x^] (`EXP`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/math.sql-spec[exp]
--------------------------------------------------
* https://docs.oracle.com/javase/8/docs/api/java/lang/Math.html#expm1-double-[e^x^ - 1] (`EXPM1`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/math.sql-spec[expm1]
--------------------------------------------------
==== Trigonometric
* Convert from https://en.wikipedia.org/wiki/Radian[radians]
to https://en.wikipedia.org/wiki/Degree_(angle)[degrees] (`DEGREES`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/math.sql-spec[degrees]
--------------------------------------------------
* Convert from https://en.wikipedia.org/wiki/Degree_(angle)[degrees]
to https://en.wikipedia.org/wiki/Radian[radians] (`RADIANS`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/math.sql-spec[degrees]
--------------------------------------------------
* https://en.wikipedia.org/wiki/Trigonometric_functions#sine[Sine] (`SIN`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/math.sql-spec[sin]
--------------------------------------------------
* https://en.wikipedia.org/wiki/Trigonometric_functions#cosine[Cosine] (`COS`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/math.sql-spec[cos]
--------------------------------------------------
* https://en.wikipedia.org/wiki/Trigonometric_functions#tangent[Tangent] (`TAN`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/math.sql-spec[tan]
--------------------------------------------------
* https://en.wikipedia.org/wiki/Inverse_trigonometric_functions[Arc sine] (`ASIN`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/math.sql-spec[asin]
--------------------------------------------------
* https://en.wikipedia.org/wiki/Inverse_trigonometric_functions[Arc cosine] (`ACOS`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/math.sql-spec[acos]
--------------------------------------------------
* https://en.wikipedia.org/wiki/Inverse_trigonometric_functions[Arc tangent] (`ATAN`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/math.sql-spec[atan]
--------------------------------------------------
* https://en.wikipedia.org/wiki/Hyperbolic_function[Hyperbolic sine] (`SINH`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/math.sql-spec[sinh]
--------------------------------------------------
* https://en.wikipedia.org/wiki/Hyperbolic_function[Hyperbolic cosine] (`COSH`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/math.sql-spec[cosh]
--------------------------------------------------
Revert "Revert "Merge branch 'feature/sql'"" This reverts commit elastic/x-pack-elasticsearch@cc79e199112db85b08a6e0682b123bb2a82445e8. We'll merge this when we're good and ready. Original commit: elastic/x-pack-elasticsearch@b3ef4f2836eda281bce7c3c2c1730933d868efa9
2017-12-13 10:19:31 -05:00
SQL: Expose WEEK function and document datetime functions (elastic/x-pack-elasticsearch#3680) Adds documentation for all of the date time functions using the new cli-like format extracted from the csv spec. In the process of doing this I noticed that the `WEEK` function isn't exposed as a function. This exposes it for consistency. Relates to elastic/x-pack-elasticsearch#2898 Original commit: elastic/x-pack-elasticsearch@0459b24cb9a26e80bb71f70874de3499c1e98ba9
2018-01-23 07:11:43 -05:00
[[sql-functions-datetime]]
SQL: Fix constant folding of datetime functions (elastic/x-pack-elasticsearch#3637) I went to write some docs for datetime functions that look like: ``` SELECT YEAR(CAST('2018-01-19T10:23:27Z' AS TIMESTAMP)) as year; year 2018 ``` because I figured they'd be pretty easy to read because they didn't require any knowledge of a data set. But it turns out that constant folding doesn't work properly for date time functions because they don't actually apply the extraction. Original commit: elastic/x-pack-elasticsearch@aa9c66b2c747c34525c8340daf3c9613620de9cf
2018-01-19 15:11:37 -05:00
=== Date and Time Functions
* Extract the year from a date (`YEAR`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/datetime.csv-spec[year]
--------------------------------------------------
SQL: Expose WEEK function and document datetime functions (elastic/x-pack-elasticsearch#3680) Adds documentation for all of the date time functions using the new cli-like format extracted from the csv spec. In the process of doing this I noticed that the `WEEK` function isn't exposed as a function. This exposes it for consistency. Relates to elastic/x-pack-elasticsearch#2898 Original commit: elastic/x-pack-elasticsearch@0459b24cb9a26e80bb71f70874de3499c1e98ba9
2018-01-23 07:11:43 -05:00
* Extract the month of the year from a date (`MONTH_OF_YEAR` or `MONTH`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/datetime.csv-spec[monthOfYear]
--------------------------------------------------
* Extract the week of the year from a date (`WEEK_OF_YEAR` or `WEEK`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/datetime.csv-spec[weekOfYear]
--------------------------------------------------
* Extract the day of the year from a date (`DAY_OF_YEAR` or `DOY`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/datetime.csv-spec[dayOfYear]
--------------------------------------------------
* Extract the day of the month from a date (`DAY_OF_MONTH`, `DOM`, or `DAY`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/datetime.csv-spec[dayOfMonth]
--------------------------------------------------
* Extract the day of the week from a date (`DAY_OF_WEEK` or `DOW`).
Monday is `1`, Tuesday is `2`, etc.
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/datetime.csv-spec[dayOfWeek]
--------------------------------------------------
* Extract the hour of the day from a date (`HOUR_OF_DAY` or `HOUR`).
Monday is `1`, Tuesday is `2`, etc.
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/datetime.csv-spec[hourOfDay]
--------------------------------------------------
* Extract the minute of the day from a date (`MINUTE_OF_DAY`).
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/datetime.csv-spec[minuteOfDay]
--------------------------------------------------
* Extract the minute of the hour from a date (`MINUTE_OF_HOUR`, `MINUTE`).
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/datetime.csv-spec[minuteOfHour]
--------------------------------------------------
* Extract the second of the minute from a date (`SECOND_OF_MINUTE`, `SECOND`).
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/datetime.csv-spec[secondOfMinute]
--------------------------------------------------
SQL: Docs for basic aggregations Adds documentation for basic aggregate functions supported by Elasticsearch SQL. Relates to elastic/x-pack-elasticsearch#2898 Original commit: elastic/x-pack-elasticsearch@ddc71165f26f6869c37a54d3e561537007d6f081
2018-01-23 10:59:44 -05:00
[[sql-functions-aggregate]]
=== Aggregate Functions
SQL: Expose WEEK function and document datetime functions (elastic/x-pack-elasticsearch#3680) Adds documentation for all of the date time functions using the new cli-like format extracted from the csv spec. In the process of doing this I noticed that the `WEEK` function isn't exposed as a function. This exposes it for consistency. Relates to elastic/x-pack-elasticsearch#2898 Original commit: elastic/x-pack-elasticsearch@0459b24cb9a26e80bb71f70874de3499c1e98ba9
2018-01-23 07:11:43 -05:00
SQL: Docs for basic aggregations Adds documentation for basic aggregate functions supported by Elasticsearch SQL. Relates to elastic/x-pack-elasticsearch#2898 Original commit: elastic/x-pack-elasticsearch@ddc71165f26f6869c37a54d3e561537007d6f081
2018-01-23 10:59:44 -05:00
==== Basic
* https://en.wikipedia.org/wiki/Arithmetic_mean[Average] (`AVG`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/agg.sql-spec[avg]
--------------------------------------------------
* Count the number of matching fields (`COUNT`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/agg.sql-spec[countStar]
--------------------------------------------------
* Count the number of distinct values in matching documents (`COUNT(DISTINCT`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/agg.sql-spec[countDistinct]
--------------------------------------------------
* Find the maximum value in matching documents (`MAX`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/agg.sql-spec[max]
--------------------------------------------------
Revert "Revert "Merge branch 'feature/sql'"" This reverts commit elastic/x-pack-elasticsearch@cc79e199112db85b08a6e0682b123bb2a82445e8. We'll merge this when we're good and ready. Original commit: elastic/x-pack-elasticsearch@b3ef4f2836eda281bce7c3c2c1730933d868efa9
2017-12-13 10:19:31 -05:00
SQL: Docs for basic aggregations Adds documentation for basic aggregate functions supported by Elasticsearch SQL. Relates to elastic/x-pack-elasticsearch#2898 Original commit: elastic/x-pack-elasticsearch@ddc71165f26f6869c37a54d3e561537007d6f081
2018-01-23 10:59:44 -05:00
* Find the minimum value in matching documents (`MIN`)
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/agg.sql-spec[min]
--------------------------------------------------
* https://en.wikipedia.org/wiki/Kahan_summation_algorithm[Sum]
all values of matching documents (`SUM`).
["source","sql",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{sql-specs}/agg.csv-spec[sum]
--------------------------------------------------