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/math.asciidoc

704 lines
18 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-math]]
=== Math Functions
All math and trigonometric functions require their input (where applicable)
to be numeric.
==== Generic
SQL: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
[[sql-functions-math-abs]]
===== `ABS`
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
.Synopsis:
[source, sql]
--------------------------------------------------
ABS(numeric_exp<1>)
--------------------------------------------------
*Input*:
<1> numeric expression
*Output*: numeric
.Description:
Returns the https://en.wikipedia.org/wiki/Absolute_value[absolute value] of `numeric_exp`. The return type is the same as the input type.
["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[abs]
SQL: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
--------------------------------------------------
[[sql-functions-math-cbrt]]
===== `CBRT`
.Synopsis:
[source, sql]
--------------------------------------------------
CBRT(numeric_exp<1>)
--------------------------------------------------
*Input*:
<1> numeric expression
*Output*: double numeric value
.Description:
Returns the https://en.wikipedia.org/wiki/Cube_root[cube root] of `numeric_exp`.
["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[mathInlineCbrtWithNegativeValue]
SQL: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
--------------------------------------------------
[[sql-functions-math-ceil]]
===== `CEIL/CEILING`
.Synopsis:
[source, sql]
--------------------------------------------------
CEIL(numeric_exp<1>)
--------------------------------------------------
*Input*:
<1> numeric expression
*Output*: integer or long numeric value
.Description:
Returns the smallest integer greater than or equal to `numeric_exp`.
["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[mathInlineCeiling]
SQL: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
--------------------------------------------------
[[sql-functions-math-e]]
===== `E`
.Synopsis:
[source, sql]
--------------------------------------------------
E()
--------------------------------------------------
*Input*: _none_
*Output*: `2.718281828459045`
.Description:
Returns https://en.wikipedia.org/wiki/E_%28mathematical_constant%29[Euler's number].
["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[mathEulersNumber]
SQL: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
--------------------------------------------------
[[sql-functions-math-exp]]
===== `EXP`
.Synopsis:
[source, sql]
--------------------------------------------------
EXP(numeric_exp<1>)
--------------------------------------------------
*Input*:
<1> float numeric expression
*Output*: double numeric value
.Description:
Returns https://en.wikipedia.org/wiki/Exponential_function[Euler's number at the power] of `numeric_exp` e^numeric_exp^.
["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[mathExpInline]
SQL: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
--------------------------------------------------
[[sql-functions-math-expm1]]
===== `EXPM1`
.Synopsis:
[source, sql]
--------------------------------------------------
EXPM1(numeric_exp<1>)
--------------------------------------------------
*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: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
<1> float numeric expression
*Output*: double numeric value
.Description:
Returns https://docs.oracle.com/javase/8/docs/api/java/lang/Math.html#expm1-double-[Euler's number at the power] of `numeric_exp` minus 1 (e^numeric_exp^ - 1).
["source","sql",subs="attributes,macros"]
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: 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[mathExpm1Inline]
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
[[sql-functions-math-floor]]
===== `FLOOR`
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
.Synopsis:
[source, sql]
--------------------------------------------------
FLOOR(numeric_exp<1>)
--------------------------------------------------
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04: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: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
<1> numeric expression
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
*Output*: integer or long 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: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04: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: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
Returns the largest integer less than or equal to `numeric_exp`.
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04: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[mathInlineFloor]
SQL: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04: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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
[[sql-functions-math-log]]
===== `LOG`
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
.Synopsis:
[source, sql]
--------------------------------------------------
LOG(numeric_exp<1>)
--------------------------------------------------
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04: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: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
<1> numeric expression
*Output*: double numeric value
.Description:
Returns the https://en.wikipedia.org/wiki/Natural_logarithm[natural logarithm] of `numeric_exp`.
["source","sql",subs="attributes,macros"]
SQL: TRUNCATE and ROUND functions (#33779) * Added TRUNCATE function, modified ROUND to accept two parameters instead of one. Made the second parameter optional for both functions. * Added documentation for both functions.
2018-09-20 08:29:53 -04:00
--------------------------------------------------
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[mathInlineLog]
SQL: TRUNCATE and ROUND functions (#33779) * Added TRUNCATE function, modified ROUND to accept two parameters instead of one. Made the second parameter optional for both functions. * Added documentation for both functions.
2018-09-20 08:29:53 -04: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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
[[sql-functions-math-log10]]
===== `LOG10`
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
.Synopsis:
[source, sql]
SQL: TRUNCATE and ROUND functions (#33779) * Added TRUNCATE function, modified ROUND to accept two parameters instead of one. Made the second parameter optional for both functions. * Added documentation for both functions.
2018-09-20 08:29:53 -04:00
--------------------------------------------------
SQL: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
LOG10(numeric_exp<1>)
SQL: TRUNCATE and ROUND functions (#33779) * Added TRUNCATE function, modified ROUND to accept two parameters instead of one. Made the second parameter optional for both functions. * Added documentation for both functions.
2018-09-20 08:29:53 -04: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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
*Input*:
<1> numeric expression
*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: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04: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: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
Returns the https://en.wikipedia.org/wiki/Common_logarithm[base 10 logarithm] of `numeric_exp`.
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
["source","sql",subs="attributes,macros"]
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: 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[mathInlineLog10]
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
[[sql-functions-math-pi]]
===== `PI`
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
.Synopsis:
[source, sql]
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
PI()
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
*Input*: _none_
*Output*: `3.141592653589793`
.Description:
Returns https://en.wikipedia.org/wiki/Pi[PI number].
["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[mathPINumber]
SQL: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
--------------------------------------------------
[[sql-functions-math-power]]
===== `POWER`
.Synopsis:
[source, sql]
--------------------------------------------------
POWER(numeric_exp<1>, integer_exp<2>)
--------------------------------------------------
*Input*:
<1> numeric expression
<2> integer expression
*Output*: double numeric value
.Description:
Returns the value of `numeric_exp` to the power of `integer_exp`.
["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[mathInlinePowerPositive]
SQL: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04: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[mathInlinePowerNegative]
SQL: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
--------------------------------------------------
SQL: Functions enhancements (OCTET_LENGTH function, order functions alphabetically, RANDOM function docs) (#34101) * New OCTET_LENGTH function * Changed the way the FunctionRegistry stores functions, considering the alphabetic ordering by name * Added documentation for the RANDOM function
2018-10-08 17:20:18 -04:00
[[sql-functions-math-random]]
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
===== `RANDOM/RAND`
SQL: Functions enhancements (OCTET_LENGTH function, order functions alphabetically, RANDOM function docs) (#34101) * New OCTET_LENGTH function * Changed the way the FunctionRegistry stores functions, considering the alphabetic ordering by name * Added documentation for the RANDOM function
2018-10-08 17:20:18 -04:00
.Synopsis:
[source, sql]
--------------------------------------------------
RANDOM(seed<1>)
--------------------------------------------------
*Input*:
<1> numeric expression
*Output*: double numeric value
.Description:
Returns a random double using the given seed.
["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[mathRandom]
SQL: Functions enhancements (OCTET_LENGTH function, order functions alphabetically, RANDOM function docs) (#34101) * New OCTET_LENGTH function * Changed the way the FunctionRegistry stores functions, considering the alphabetic ordering by name * Added documentation for the RANDOM function
2018-10-08 17:20:18 -04:00
--------------------------------------------------
SQL: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
[[sql-functions-math-round]]
===== `ROUND`
SQL: TRUNCATE and ROUND functions (#33779) * Added TRUNCATE function, modified ROUND to accept two parameters instead of one. Made the second parameter optional for both functions. * Added documentation for both functions.
2018-09-20 08:29:53 -04:00
.Synopsis:
[source, sql]
----
ROUND(numeric_exp<1>[, integer_exp<2>])
----
*Input*:
SQL: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
<1> numeric expression
<2> integer expression; optional
SQL: TRUNCATE and ROUND functions (#33779) * Added TRUNCATE function, modified ROUND to accept two parameters instead of one. Made the second parameter optional for both functions. * Added documentation for both functions.
2018-09-20 08:29:53 -04:00
*Output*: numeric
.Description:
Returns `numeric_exp` rounded to `integer_exp` places right of the decimal point. If `integer_exp` is negative,
`numeric_exp` is rounded to |`integer_exp`| places to the left of the decimal point. If `integer_exp` is omitted,
the function will perform as if `integer_exp` would be 0. The returned numeric data type is the same as the data type
of `numeric_exp`.
SQL: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
["source","sql",subs="attributes,macros"]
SQL: TRUNCATE and ROUND functions (#33779) * Added TRUNCATE function, modified ROUND to accept two parameters instead of one. Made the second parameter optional for both functions. * Added documentation for both functions.
2018-09-20 08:29:53 -04:00
--------------------------------------------------
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[mathRoundWithPositiveParameter]
SQL: TRUNCATE and ROUND functions (#33779) * Added TRUNCATE function, modified ROUND to accept two parameters instead of one. Made the second parameter optional for both functions. * Added documentation for both functions.
2018-09-20 08:29:53 -04:00
--------------------------------------------------
SQL: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
["source","sql",subs="attributes,macros"]
SQL: TRUNCATE and ROUND functions (#33779) * Added TRUNCATE function, modified ROUND to accept two parameters instead of one. Made the second parameter optional for both functions. * Added documentation for both functions.
2018-09-20 08:29:53 -04:00
--------------------------------------------------
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[mathRoundWithNegativeParameter]
SQL: TRUNCATE and ROUND functions (#33779) * Added TRUNCATE function, modified ROUND to accept two parameters instead of one. Made the second parameter optional for both functions. * Added documentation for both functions.
2018-09-20 08:29:53 -04:00
--------------------------------------------------
SQL: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
[[sql-functions-math-sign]]
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
===== `SIGN/SIGNUM`
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
.Synopsis:
[source, sql]
--------------------------------------------------
SIGN(numeric_exp<1>)
--------------------------------------------------
*Input*:
<1> numeric expression
*Output*: [-1, 0, 1]
.Description:
Returns an indicator of the sign of `numeric_exp`. If `numeric_exp` is less than zero, –1 is returned. If `numeric_exp` equals zero, 0 is returned. If `numeric_exp` is greater than zero, 1 is returned.
["source","sql",subs="attributes,macros"]
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: 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[mathInlineSign]
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
[[sql-functions-math-sqrt]]
===== `SQRT`
.Synopsis:
[source, sql]
--------------------------------------------------
SQRT(numeric_exp<1>)
--------------------------------------------------
*Input*:
<1> numeric expression
*Output*: double numeric value
.Description:
Returns https://en.wikipedia.org/wiki/Square_root[square root] of `numeric_exp`.
["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[mathInlineSqrt]
SQL: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
--------------------------------------------------
[[sql-functions-math-truncate]]
===== `TRUNCATE`
SQL: TRUNCATE and ROUND functions (#33779) * Added TRUNCATE function, modified ROUND to accept two parameters instead of one. Made the second parameter optional for both functions. * Added documentation for both functions.
2018-09-20 08:29:53 -04:00
.Synopsis:
[source, sql]
----
TRUNCATE(numeric_exp<1>[, integer_exp<2>])
----
*Input*:
SQL: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
<1> numeric expression
<2> integer expression; optional
SQL: TRUNCATE and ROUND functions (#33779) * Added TRUNCATE function, modified ROUND to accept two parameters instead of one. Made the second parameter optional for both functions. * Added documentation for both functions.
2018-09-20 08:29:53 -04:00
*Output*: numeric
.Description:
Returns `numeric_exp` truncated to `integer_exp` places right of the decimal point. If `integer_exp` is negative,
`numeric_exp` is truncated to |`integer_exp`| places to the left of the decimal point. If `integer_exp` is omitted,
the function will perform as if `integer_exp` would be 0. The returned numeric data type is the same as the data type
of `numeric_exp`.
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
["source","sql",subs="attributes,macros"]
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: 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[mathTruncateWithPositiveParameter]
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
["source","sql",subs="attributes,macros"]
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: 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[mathTruncateWithNegativeParameter]
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
--------------------------------------------------
==== Trigonometric
SQL: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
[[sql-functions-math-acos]]
===== `ACOS`
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
.Synopsis:
[source, sql]
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
ACOS(numeric_exp<1>)
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
*Input*:
<1> numeric expression
*Output*: double numeric value
.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: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
Returns the https://en.wikipedia.org/wiki/Inverse_trigonometric_functions[arccosine] of `numeric_exp` as an angle, expressed in radians.
["source","sql",subs="attributes,macros"]
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: 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[mathInlineAcos]
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
[[sql-functions-math-asin]]
===== `ASIN`
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
.Synopsis:
[source, sql]
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
ASIN(numeric_exp<1>)
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
*Input*:
<1> numeric expression
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
*Output*: double numeric value
.Description:
Returns the https://en.wikipedia.org/wiki/Inverse_trigonometric_functions[arcsine] of `numeric_exp` as an angle, expressed in radians.
["source","sql",subs="attributes,macros"]
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: 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[mathInlineAsin]
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
[[sql-functions-math-atan]]
===== `ATAN`
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
.Synopsis:
[source, sql]
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
ATAN(numeric_exp<1>)
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
*Input*:
<1> numeric expression
*Output*: double numeric value
.Description:
Returns the https://en.wikipedia.org/wiki/Inverse_trigonometric_functions[arctangent] of `numeric_exp` as an angle, expressed in radians.
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
["source","sql",subs="attributes,macros"]
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: 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[mathInlineAtan]
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
[[sql-functions-math-atan2]]
===== `ATAN2`
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
.Synopsis:
[source, sql]
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
ATAN2(ordinate<1>, abscisa<2>)
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
*Input*:
<1> numeric expression
<2> numeric expression
*Output*: double numeric value
.Description:
Returns the https://en.wikipedia.org/wiki/Atan2[arctangent of the `ordinate` and `abscisa` coordinates] specified as an angle, expressed in radians.
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
["source","sql",subs="attributes,macros"]
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: 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[mathInlineAtan2]
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
[[sql-functions-math-cos]]
===== `COS`
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
.Synopsis:
[source, sql]
--------------------------------------------------
COS(numeric_exp<1>)
--------------------------------------------------
*Input*:
<1> numeric expression
*Output*: double numeric value
.Description:
Returns the https://en.wikipedia.org/wiki/Trigonometric_functions#cosine[cosine] of `numeric_exp`, where `numeric_exp` is an angle expressed in radians.
["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[mathInlineCosine]
SQL: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
--------------------------------------------------
[[sql-functions-math-cosh]]
===== `COSH`
.Synopsis:
[source, sql]
--------------------------------------------------
COSH(numeric_exp<1>)
--------------------------------------------------
*Input*:
<1> numeric expression
*Output*: double numeric value
.Description:
Returns the https://en.wikipedia.org/wiki/Hyperbolic_function[hyperbolic cosine] of `numeric_exp`.
["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[mathInlineCosh]
SQL: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
--------------------------------------------------
[[sql-functions-math-cot]]
===== `COT`
.Synopsis:
[source, sql]
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
COT(numeric_exp<1>)
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
*Input*:
<1> numeric expression
*Output*: double numeric value
.Description:
Returns the https://en.wikipedia.org/wiki/Trigonometric_functions#Cosecant,_secant,_and_cotangent[cotangent] of `numeric_exp`, where `numeric_exp` is an angle expressed in radians.
["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[mathInlineCotangent]
SQL: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
--------------------------------------------------
[[sql-functions-math-degrees]]
===== `DEGREES`
.Synopsis:
[source, sql]
--------------------------------------------------
DEGREES(numeric_exp<1>)
--------------------------------------------------
*Input*:
<1> numeric expression
*Output*: double numeric value
.Description:
Convert from https://en.wikipedia.org/wiki/Radian[radians]
to https://en.wikipedia.org/wiki/Degree_(angle)[degrees].
["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[mathInlineDegrees]
SQL: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
--------------------------------------------------
[[sql-functions-math-radians]]
===== `RADIANS`
.Synopsis:
[source, sql]
--------------------------------------------------
RADIANS(numeric_exp<1>)
--------------------------------------------------
*Input*:
<1> numeric expression
*Output*: double numeric value
.Description:
Convert from https://en.wikipedia.org/wiki/Degree_(angle)[degrees]
to https://en.wikipedia.org/wiki/Radian[radians].
["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[mathInlineRadians]
SQL: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
--------------------------------------------------
[[sql-functions-math-sin]]
===== `SIN`
.Synopsis:
[source, sql]
--------------------------------------------------
SIN(numeric_exp<1>)
--------------------------------------------------
*Input*:
<1> numeric expression
*Output*: double numeric value
.Description:
Returns the https://en.wikipedia.org/wiki/Trigonometric_functions#sine[sine] of `numeric_exp`, where `numeric_exp` is an angle expressed in radians.
["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[mathInlineSine]
SQL: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
--------------------------------------------------
[[sql-functions-math-sinh]]
===== `SINH`
.Synopsis:
[source, sql]
--------------------------------------------------
SINH(numeric_exp<1>)
--------------------------------------------------
*Input*:
<1> numeric expression
*Output*: double numeric value
.Description:
Returns the https://en.wikipedia.org/wiki/Hyperbolic_function[hyperbolic sine] of `numeric_exp`.
["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[mathInlineSinh]
SQL: functions docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
--------------------------------------------------
[[sql-functions-math-tan]]
===== `TAN`
.Synopsis:
[source, sql]
--------------------------------------------------
TAN(numeric_exp<1>)
--------------------------------------------------
*Input*:
<1> numeric expression
*Output*: double numeric value
.Description:
Returns the https://en.wikipedia.org/wiki/Trigonometric_functions#tangent[tangent] of `numeric_exp`, where `numeric_exp` is an angle expressed in radians.
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 docs update (#34000) * Changed the format of the String functions documentation page. * Adopted the same format for Math functions, but completely changed the examples. * Added missing documentation for Math functions.
2018-09-24 19:42:18 -04:00
["source","sql",subs="attributes,macros"]
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: 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[mathInlineTanget]
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
--------------------------------------------------