elasticsearch/docs/reference/esql/functions/to_long.asciidoc

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

37 lines
1.2 KiB
Plaintext
Raw Normal View History

[discrete]
[[esql-to_long]]
=== `TO_LONG`
Converts an input value to a long value.
The input can be a single- or multi-valued field or an expression. 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\""`
If the input parameter is of a date type, its value will be interpreted as
milliseconds since the https://en.wikipedia.org/wiki/Unix_time[Unix epoch],
converted to long.
Boolean *true* will be converted to long *1*, *false* to *0*.