mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 15:47:23 -04:00
e87c49cb4b
* Functions E-Z * Incorporate changes from #103686 * More functions * More functions * Update docs/reference/esql/functions/floor.asciidoc Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com> * Update docs/reference/esql/functions/left.asciidoc Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Alexander Spies <alexander.spies@elastic.co> * Review feedback * Fix geo_shape description * Change 'colum'/'field' into 'expressions' * Review feedback * One more --------- Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com> Co-authored-by: Alexander Spies <alexander.spies@elastic.co> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
54 lines
1.3 KiB
Text
54 lines
1.3 KiB
Text
[discrete]
|
|
[[esql-to_integer]]
|
|
=== `TO_INTEGER`
|
|
|
|
*Alias*
|
|
|
|
`TO_INT`
|
|
|
|
*Syntax*
|
|
|
|
[source,esql]
|
|
----
|
|
TO_INTEGER(v)
|
|
----
|
|
|
|
*Parameters*
|
|
|
|
`v`::
|
|
Input value. The input can be a single- or multi-valued column or an expression.
|
|
|
|
*Description*
|
|
|
|
Converts an input value to an integer value.
|
|
|
|
If the input parameter is of a date type, its value will be interpreted as
|
|
milliseconds since the {wikipedia}/Unix_time[Unix epoch], converted to integer.
|
|
|
|
Boolean *true* will be converted to integer *1*, *false* to *0*.
|
|
|
|
*Supported types*
|
|
|
|
The input type must be of a boolean, date, string or numeric type.
|
|
|
|
*Example*
|
|
|
|
[source.merge.styled,esql]
|
|
----
|
|
include::{esql-specs}/ints.csv-spec[tag=to_int-long]
|
|
----
|
|
[%header.monospaced.styled,format=dsv,separator=|]
|
|
|===
|
|
include::{esql-specs}/ints.csv-spec[tag=to_int-long-result]
|
|
|===
|
|
|
|
Note that in this example, the last value of the multi-valued field cannot
|
|
be converted as an integer. When this happens, the result is a *null* value.
|
|
In this case a _Warning_ header is added to the response. The header will
|
|
provide information on the source of the failure:
|
|
|
|
`"Line 1:61: evaluation of [TO_INTEGER(long)] failed, treating result as null. Only first 20 failures recorded."`
|
|
|
|
A following header will contain the failure reason and the offending value:
|
|
|
|
`"org.elasticsearch.xpack.ql.InvalidArgumentException: [501379200000] out of [integer] range"`
|