elasticsearch/docs/reference/esql/functions/to_long.asciidoc
Abdon Pijpelink e87c49cb4b
[DOCS] Improve ES|QL functions reference for functions E-Z (#104623)
* 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>
2024-01-25 16:32:24 +01:00

50 lines
1.2 KiB
Text

[discrete]
[[esql-to_long]]
=== `TO_LONG`
*Syntax*
[source,esql]
----
TO_LONG(v)
----
*Parameters*
`v`::
Input value. The input can be a single- or multi-valued column or an expression.
*Description*
Converts an input value to a long 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 long.
Boolean *true* will be converted to long *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_long-str]
----
[%header.monospaced.styled,format=dsv,separator=|]
|===
include::{esql-specs}/ints.csv-spec[tag=to_long-str-result]
|===
Note that in this example, the last conversion of the string isn't
possible. 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:113: evaluation of [TO_LONG(str3)] failed, treating result as null. Only first 20 failures recorded."`
A following header will contain the failure reason and the offending value:
`"java.lang.NumberFormatException: For input string: \"foo\""`