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

[discrete]
[[esql-to_unsigned_long]]
=== `TO_UNSIGNED_LONG`

experimental::[]

*Aliases*

`TO_ULONG`, `TO_UL`

*Syntax*

[source,esql]
----
TO_UNSIGNED_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 an unsigned long value.

*Supported types*

The input type must be of a boolean, date, string or numeric type.

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 unsigned
long.

Boolean *true* will be converted to unsigned long *1*, *false* to *0*.

*Example*

[source.merge.styled,esql]
----
include::{esql-specs}/ints.csv-spec[tag=to_unsigned_long-str]
----
[%header.monospaced.styled,format=dsv,separator=|]
|===
include::{esql-specs}/ints.csv-spec[tag=to_unsigned_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:133: evaluation of [TO_UL(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: Character f is neither a decimal digit number, decimal point, nor \"e\" notation exponential mark."`