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

511 lines
12 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-string]]
=== String Functions
Functions for performing string manipulation.
[[sql-functions-string-ascii]]
==== `ASCII`
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]
--------------------------------------------------
Docs: Drop inline callouts from two SQL pages (#41270) Drops inline callouts from the docs for SQL's string and type-conversion functions because they are not compatible with Asciidoctor.
2019-04-16 15:27:51 -04:00
ASCII(string_exp) <1>
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
*Input*:
<1> string expression
*Output*: integer
.Description:
Returns the ASCII code value of the leftmost character of `string_exp` as an integer.
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
[DOCS] Remove unneeded options from `[source,sql]` code blocks (#42759) In AsciiDoc, `subs="attributes,callouts,macros"` options were required to render `include-tagged::` in a code block. With elastic/docs#827, Elasticsearch Reference documentation migrated from AsciiDoc to Asciidoctor. In Asciidoctor, the `subs="attributes,callouts,macros"` options are no longer needed to render `include-tagged::` in a code block. This commit removes those unneeded options. Resolves #41589
2019-05-31 13:03:41 -04:00
[source, sql]
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: 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[stringAscii]
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-string-bit-length]]
==== `BIT_LENGTH`
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]
--------------------------------------------------
Docs: Drop inline callouts from two SQL pages (#41270) Drops inline callouts from the docs for SQL's string and type-conversion functions because they are not compatible with Asciidoctor.
2019-04-16 15:27:51 -04:00
BIT_LENGTH(string_exp) <1>
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> string expression
*Output*: integer
.Description:
Returns the length in bits of the `string_exp` input 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
[DOCS] Remove unneeded options from `[source,sql]` code blocks (#42759) In AsciiDoc, `subs="attributes,callouts,macros"` options were required to render `include-tagged::` in a code block. With elastic/docs#827, Elasticsearch Reference documentation migrated from AsciiDoc to Asciidoctor. In Asciidoctor, the `subs="attributes,callouts,macros"` options are no longer needed to render `include-tagged::` in a code block. This commit removes those unneeded options. Resolves #41589
2019-05-31 13:03:41 -04:00
[source, sql]
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: 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[stringBitLength]
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-string-char]]
==== `CHAR`
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]
--------------------------------------------------
Docs: Drop inline callouts from two SQL pages (#41270) Drops inline callouts from the docs for SQL's string and type-conversion functions because they are not compatible with Asciidoctor.
2019-04-16 15:27:51 -04:00
CHAR(code) <1>
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> integer expression
*Output*: string
.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
Returns the character that has the ASCII code value specified by the numeric input. The value should be between 0 and 255; otherwise, the return value is data source–dependent.
[DOCS] Remove unneeded options from `[source,sql]` code blocks (#42759) In AsciiDoc, `subs="attributes,callouts,macros"` options were required to render `include-tagged::` in a code block. With elastic/docs#827, Elasticsearch Reference documentation migrated from AsciiDoc to Asciidoctor. In Asciidoctor, the `subs="attributes,callouts,macros"` options are no longer needed to render `include-tagged::` in a code block. This commit removes those unneeded options. Resolves #41589
2019-05-31 13:03:41 -04:00
[source, sql]
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: 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[stringChar]
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-string-char-length]]
==== `CHAR_LENGTH`
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]
--------------------------------------------------
Docs: Drop inline callouts from two SQL pages (#41270) Drops inline callouts from the docs for SQL's string and type-conversion functions because they are not compatible with Asciidoctor.
2019-04-16 15:27:51 -04:00
CHAR_LENGTH(string_exp) <1>
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> string expression
*Output*: integer
.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
Returns the length in characters of the input, if the string expression is of a character data type; otherwise, returns the length in bytes of the string expression (the smallest integer not less than the number of bits divided by 8).
[DOCS] Remove unneeded options from `[source,sql]` code blocks (#42759) In AsciiDoc, `subs="attributes,callouts,macros"` options were required to render `include-tagged::` in a code block. With elastic/docs#827, Elasticsearch Reference documentation migrated from AsciiDoc to Asciidoctor. In Asciidoctor, the `subs="attributes,callouts,macros"` options are no longer needed to render `include-tagged::` in a code block. This commit removes those unneeded options. Resolves #41589
2019-05-31 13:03:41 -04:00
[source, sql]
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: 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[stringCharLength]
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-string-concat]]
==== `CONCAT`
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]
--------------------------------------------------
Docs: Drop inline callouts from two SQL pages (#41270) Drops inline callouts from the docs for SQL's string and type-conversion functions because they are not compatible with Asciidoctor.
2019-04-16 15:27:51 -04:00
CONCAT(
string_exp1, <1>
string_exp2) <2>
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> string expression
<2> string expression
*Output*: string
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:
Returns a character string that is the result of concatenating `string_exp1` to `string_exp2`. If one of the string is `NULL`, the other string will be returned.
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
[DOCS] Remove unneeded options from `[source,sql]` code blocks (#42759) In AsciiDoc, `subs="attributes,callouts,macros"` options were required to render `include-tagged::` in a code block. With elastic/docs#827, Elasticsearch Reference documentation migrated from AsciiDoc to Asciidoctor. In Asciidoctor, the `subs="attributes,callouts,macros"` options are no longer needed to render `include-tagged::` in a code block. This commit removes those unneeded options. Resolves #41589
2019-05-31 13:03:41 -04:00
[source, sql]
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: 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[stringConcat]
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-string-insert]]
==== `INSERT`
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]
--------------------------------------------------
Docs: Drop inline callouts from two SQL pages (#41270) Drops inline callouts from the docs for SQL's string and type-conversion functions because they are not compatible with Asciidoctor.
2019-04-16 15:27:51 -04:00
INSERT(
source, <1>
start, <2>
length, <3>
replacement) <4>
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> string expression
<2> integer expression
<3> integer expression
<4> string expression
*Output*: string
.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 a string where `length` characters have been deleted from `source`, beginning at `start`, and where `replacement` has been inserted into `source`, beginning at `start`.
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
[DOCS] Remove unneeded options from `[source,sql]` code blocks (#42759) In AsciiDoc, `subs="attributes,callouts,macros"` options were required to render `include-tagged::` in a code block. With elastic/docs#827, Elasticsearch Reference documentation migrated from AsciiDoc to Asciidoctor. In Asciidoctor, the `subs="attributes,callouts,macros"` options are no longer needed to render `include-tagged::` in a code block. This commit removes those unneeded options. Resolves #41589
2019-05-31 13:03:41 -04:00
[source, sql]
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: 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[stringInsert]
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-string-lcase]]
==== `LCASE`
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]
--------------------------------------------------
Docs: Drop inline callouts from two SQL pages (#41270) Drops inline callouts from the docs for SQL's string and type-conversion functions because they are not compatible with Asciidoctor.
2019-04-16 15:27:51 -04:00
LCASE(string_exp) <1>
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> string expression
*Output*: string
.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 a string equal to that in `string_exp`, with all uppercase characters converted to lowercase.
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
[DOCS] Remove unneeded options from `[source,sql]` code blocks (#42759) In AsciiDoc, `subs="attributes,callouts,macros"` options were required to render `include-tagged::` in a code block. With elastic/docs#827, Elasticsearch Reference documentation migrated from AsciiDoc to Asciidoctor. In Asciidoctor, the `subs="attributes,callouts,macros"` options are no longer needed to render `include-tagged::` in a code block. This commit removes those unneeded options. Resolves #41589
2019-05-31 13:03:41 -04:00
[source, sql]
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: 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[stringLCase]
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-string-left]]
==== `LEFT`
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]
--------------------------------------------------
Docs: Drop inline callouts from two SQL pages (#41270) Drops inline callouts from the docs for SQL's string and type-conversion functions because they are not compatible with Asciidoctor.
2019-04-16 15:27:51 -04:00
LEFT(
string_exp, <1>
count) <2>
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> string expression
<2> integer expression
*Output*: string
.Description:
Returns the leftmost count characters of `string_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
[DOCS] Remove unneeded options from `[source,sql]` code blocks (#42759) In AsciiDoc, `subs="attributes,callouts,macros"` options were required to render `include-tagged::` in a code block. With elastic/docs#827, Elasticsearch Reference documentation migrated from AsciiDoc to Asciidoctor. In Asciidoctor, the `subs="attributes,callouts,macros"` options are no longer needed to render `include-tagged::` in a code block. This commit removes those unneeded options. Resolves #41589
2019-05-31 13:03:41 -04:00
[source, sql]
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: 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[stringLeft]
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-string-length]]
==== `LENGTH`
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]
--------------------------------------------------
Docs: Drop inline callouts from two SQL pages (#41270) Drops inline callouts from the docs for SQL's string and type-conversion functions because they are not compatible with Asciidoctor.
2019-04-16 15:27:51 -04:00
LENGTH(string_exp) <1>
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> string 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
.Description:
Returns the number of characters in `string_exp`, excluding trailing blanks.
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
[DOCS] Remove unneeded options from `[source,sql]` code blocks (#42759) In AsciiDoc, `subs="attributes,callouts,macros"` options were required to render `include-tagged::` in a code block. With elastic/docs#827, Elasticsearch Reference documentation migrated from AsciiDoc to Asciidoctor. In Asciidoctor, the `subs="attributes,callouts,macros"` options are no longer needed to render `include-tagged::` in a code block. This commit removes those unneeded options. Resolves #41589
2019-05-31 13:03:41 -04:00
[source, sql]
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: 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[stringLength]
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-string-locate]]
==== `LOCATE`
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]
--------------------------------------------------
Docs: Drop inline callouts from two SQL pages (#41270) Drops inline callouts from the docs for SQL's string and type-conversion functions because they are not compatible with Asciidoctor.
2019-04-16 15:27:51 -04:00
LOCATE(
pattern, <1>
source <2>
[, start]<3>
)
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> string expression
<2> string expression
<3> integer expression; optional
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
.Description:
Returns the starting position of the first occurrence of `pattern` within `source`. The search for the first occurrence of `pattern` begins with the first character position in `source` unless the optional argument, `start`, is specified. If `start` is specified, the search begins with the character position indicated by the value of `start`. The first character position in `source` is indicated by the value 1. If `pattern` is not found within `source`, the value 0 is returned.
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
[DOCS] Remove unneeded options from `[source,sql]` code blocks (#42759) In AsciiDoc, `subs="attributes,callouts,macros"` options were required to render `include-tagged::` in a code block. With elastic/docs#827, Elasticsearch Reference documentation migrated from AsciiDoc to Asciidoctor. In Asciidoctor, the `subs="attributes,callouts,macros"` options are no longer needed to render `include-tagged::` in a code block. This commit removes those unneeded options. Resolves #41589
2019-05-31 13:03:41 -04:00
[source, sql]
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: 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[stringLocateWoStart]
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
[DOCS] Remove unneeded options from `[source,sql]` code blocks (#42759) In AsciiDoc, `subs="attributes,callouts,macros"` options were required to render `include-tagged::` in a code block. With elastic/docs#827, Elasticsearch Reference documentation migrated from AsciiDoc to Asciidoctor. In Asciidoctor, the `subs="attributes,callouts,macros"` options are no longer needed to render `include-tagged::` in a code block. This commit removes those unneeded options. Resolves #41589
2019-05-31 13:03:41 -04:00
[source, sql]
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: 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[stringLocateWithStart]
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-string-ltrim]]
==== `LTRIM`
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]
--------------------------------------------------
Docs: Drop inline callouts from two SQL pages (#41270) Drops inline callouts from the docs for SQL's string and type-conversion functions because they are not compatible with Asciidoctor.
2019-04-16 15:27:51 -04:00
LTRIM(string_exp) <1>
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> string expression
*Output*: string
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:
Returns the characters of `string_exp`, with leading blanks removed.
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
[DOCS] Remove unneeded options from `[source,sql]` code blocks (#42759) In AsciiDoc, `subs="attributes,callouts,macros"` options were required to render `include-tagged::` in a code block. With elastic/docs#827, Elasticsearch Reference documentation migrated from AsciiDoc to Asciidoctor. In Asciidoctor, the `subs="attributes,callouts,macros"` options are no longer needed to render `include-tagged::` in a code block. This commit removes those unneeded options. Resolves #41589
2019-05-31 13:03:41 -04:00
[source, sql]
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: 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[stringLTrim]
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 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-string-octet-length]]
==== `OCTET_LENGTH`
.Synopsis:
[source, sql]
--------------------------------------------------
Docs: Drop inline callouts from two SQL pages (#41270) Drops inline callouts from the docs for SQL's string and type-conversion functions because they are not compatible with Asciidoctor.
2019-04-16 15:27:51 -04:00
OCTET_LENGTH(string_exp) <1>
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
--------------------------------------------------
*Input*:
<1> string expression
*Output*: integer
.Description:
Returns the length in bytes of the `string_exp` input expression.
[DOCS] Remove unneeded options from `[source,sql]` code blocks (#42759) In AsciiDoc, `subs="attributes,callouts,macros"` options were required to render `include-tagged::` in a code block. With elastic/docs#827, Elasticsearch Reference documentation migrated from AsciiDoc to Asciidoctor. In Asciidoctor, the `subs="attributes,callouts,macros"` options are no longer needed to render `include-tagged::` in a code block. This commit removes those unneeded options. Resolves #41589
2019-05-31 13:03:41 -04:00
[source, sql]
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: 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[stringOctetLength]
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
--------------------------------------------------
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-string-position]]
==== `POSITION`
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]
--------------------------------------------------
Docs: Drop inline callouts from two SQL pages (#41270) Drops inline callouts from the docs for SQL's string and type-conversion functions because they are not compatible with Asciidoctor.
2019-04-16 15:27:51 -04:00
POSITION(
string_exp1, <1>
string_exp2) <2>
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> string expression
<2> string expression
*Output*: integer
.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 position of the `string_exp1` in `string_exp2`. The result is an exact numeric.
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
[DOCS] Remove unneeded options from `[source,sql]` code blocks (#42759) In AsciiDoc, `subs="attributes,callouts,macros"` options were required to render `include-tagged::` in a code block. With elastic/docs#827, Elasticsearch Reference documentation migrated from AsciiDoc to Asciidoctor. In Asciidoctor, the `subs="attributes,callouts,macros"` options are no longer needed to render `include-tagged::` in a code block. This commit removes those unneeded options. Resolves #41589
2019-05-31 13:03:41 -04:00
[source, sql]
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: 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[stringPosition]
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-string-repeat]]
==== `REPEAT`
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]
--------------------------------------------------
Docs: Drop inline callouts from two SQL pages (#41270) Drops inline callouts from the docs for SQL's string and type-conversion functions because they are not compatible with Asciidoctor.
2019-04-16 15:27:51 -04:00
REPEAT(
string_exp, <1>
count) <2>
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> string expression
<2> integer expression
*Output*: string
.Description:
Returns a character string composed of `string_exp` repeated `count` times.
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
[DOCS] Remove unneeded options from `[source,sql]` code blocks (#42759) In AsciiDoc, `subs="attributes,callouts,macros"` options were required to render `include-tagged::` in a code block. With elastic/docs#827, Elasticsearch Reference documentation migrated from AsciiDoc to Asciidoctor. In Asciidoctor, the `subs="attributes,callouts,macros"` options are no longer needed to render `include-tagged::` in a code block. This commit removes those unneeded options. Resolves #41589
2019-05-31 13:03:41 -04:00
[source, sql]
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: 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[stringRepeat]
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-string-replace]]
==== `REPLACE`
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]
--------------------------------------------------
Docs: Drop inline callouts from two SQL pages (#41270) Drops inline callouts from the docs for SQL's string and type-conversion functions because they are not compatible with Asciidoctor.
2019-04-16 15:27:51 -04:00
REPLACE(
source, <1>
pattern, <2>
replacement) <3>
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> string expression
<2> string expression
<3> string 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*: string
.Description:
Search `source` for occurrences of `pattern`, and replace with `replacement`.
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
[DOCS] Remove unneeded options from `[source,sql]` code blocks (#42759) In AsciiDoc, `subs="attributes,callouts,macros"` options were required to render `include-tagged::` in a code block. With elastic/docs#827, Elasticsearch Reference documentation migrated from AsciiDoc to Asciidoctor. In Asciidoctor, the `subs="attributes,callouts,macros"` options are no longer needed to render `include-tagged::` in a code block. This commit removes those unneeded options. Resolves #41589
2019-05-31 13:03:41 -04:00
[source, sql]
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: 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[stringReplace]
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-string-right]]
==== `RIGHT`
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]
--------------------------------------------------
Docs: Drop inline callouts from two SQL pages (#41270) Drops inline callouts from the docs for SQL's string and type-conversion functions because they are not compatible with Asciidoctor.
2019-04-16 15:27:51 -04:00
RIGHT(
string_exp, <1>
count) <2>
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> string expression
<2> integer 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*: string
.Description:
Returns the rightmost count characters of `string_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
[DOCS] Remove unneeded options from `[source,sql]` code blocks (#42759) In AsciiDoc, `subs="attributes,callouts,macros"` options were required to render `include-tagged::` in a code block. With elastic/docs#827, Elasticsearch Reference documentation migrated from AsciiDoc to Asciidoctor. In Asciidoctor, the `subs="attributes,callouts,macros"` options are no longer needed to render `include-tagged::` in a code block. This commit removes those unneeded options. Resolves #41589
2019-05-31 13:03:41 -04:00
[source, sql]
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: 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[stringRight]
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-string-rtrim]]
==== `RTRIM`
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]
--------------------------------------------------
Docs: Drop inline callouts from two SQL pages (#41270) Drops inline callouts from the docs for SQL's string and type-conversion functions because they are not compatible with Asciidoctor.
2019-04-16 15:27:51 -04:00
RTRIM(string_exp) <1>
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> string expression
*Output*: string
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:
Returns the characters of `string_exp` with trailing blanks removed.
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
[DOCS] Remove unneeded options from `[source,sql]` code blocks (#42759) In AsciiDoc, `subs="attributes,callouts,macros"` options were required to render `include-tagged::` in a code block. With elastic/docs#827, Elasticsearch Reference documentation migrated from AsciiDoc to Asciidoctor. In Asciidoctor, the `subs="attributes,callouts,macros"` options are no longer needed to render `include-tagged::` in a code block. This commit removes those unneeded options. Resolves #41589
2019-05-31 13:03:41 -04:00
[source, sql]
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: 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[stringRTrim]
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-string-space]]
==== `SPACE`
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]
--------------------------------------------------
Docs: Drop inline callouts from two SQL pages (#41270) Drops inline callouts from the docs for SQL's string and type-conversion functions because they are not compatible with Asciidoctor.
2019-04-16 15:27:51 -04:00
SPACE(count) <1>
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> integer expression
*Output*: string
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:
Returns a character string consisting of `count` spaces.
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
[DOCS] Remove unneeded options from `[source,sql]` code blocks (#42759) In AsciiDoc, `subs="attributes,callouts,macros"` options were required to render `include-tagged::` in a code block. With elastic/docs#827, Elasticsearch Reference documentation migrated from AsciiDoc to Asciidoctor. In Asciidoctor, the `subs="attributes,callouts,macros"` options are no longer needed to render `include-tagged::` in a code block. This commit removes those unneeded options. Resolves #41589
2019-05-31 13:03:41 -04:00
[source, sql]
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: 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[stringSpace]
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-string-substring]]
==== `SUBSTRING`
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]
--------------------------------------------------
Docs: Drop inline callouts from two SQL pages (#41270) Drops inline callouts from the docs for SQL's string and type-conversion functions because they are not compatible with Asciidoctor.
2019-04-16 15:27:51 -04:00
SUBSTRING(
source, <1>
start, <2>
length) <3>
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> string expression
<2> integer expression
<3> integer expression
*Output*: string
.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 a character string that is derived from `source`, beginning at the character position specified by `start` for `length` characters.
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
[DOCS] Remove unneeded options from `[source,sql]` code blocks (#42759) In AsciiDoc, `subs="attributes,callouts,macros"` options were required to render `include-tagged::` in a code block. With elastic/docs#827, Elasticsearch Reference documentation migrated from AsciiDoc to Asciidoctor. In Asciidoctor, the `subs="attributes,callouts,macros"` options are no longer needed to render `include-tagged::` in a code block. This commit removes those unneeded options. Resolves #41589
2019-05-31 13:03:41 -04:00
[source, sql]
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: 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[stringSubString]
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-string-ucase]]
==== `UCASE`
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]
--------------------------------------------------
Docs: Drop inline callouts from two SQL pages (#41270) Drops inline callouts from the docs for SQL's string and type-conversion functions because they are not compatible with Asciidoctor.
2019-04-16 15:27:51 -04:00
UCASE(string_exp) <1>
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> string expression
*Output*: string
.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
Returns a string equal to that of the input, with all lowercase characters converted to uppercase.
[DOCS] Remove unneeded options from `[source,sql]` code blocks (#42759) In AsciiDoc, `subs="attributes,callouts,macros"` options were required to render `include-tagged::` in a code block. With elastic/docs#827, Elasticsearch Reference documentation migrated from AsciiDoc to Asciidoctor. In Asciidoctor, the `subs="attributes,callouts,macros"` options are no longer needed to render `include-tagged::` in a code block. This commit removes those unneeded options. Resolves #41589
2019-05-31 13:03:41 -04:00
[source, sql]
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: 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[stringUCase]
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
--------------------------------------------------