elasticsearch/docs/reference/esql/functions/to_ip.asciidoc
Abdon Pijpelink 8ac4ba751e
Restructure ES|QL docs (#100806)
* Break out 'Limitations' into separate page

* Add REST API docs

* Restructure commands, functions, and operators refs

* Add placeholder for getting started guide

* Group 'Syntax', 'Metafields', and 'MV fields' under 'Language'

* Add placeholder for Kibana page

* Add link from landing page

* Apply uniform formatting to ACOS, CASE, and DATE_PARSE function refs

* Reword default LIMIT

* Add support for COUNT(*)

* Move 'Commands' and 'Functions and operators' to individual pages

---------

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2023-10-17 17:36:14 +02:00

28 lines
871 B
Text

[discrete]
[[esql-to_ip]]
=== `TO_IP`
Converts an input string to an IP value.
The input can be a single- or multi-valued field or an expression.
Example:
[source.merge.styled,esql]
----
include::{esql-specs}/ip.csv-spec[tag=to_ip]
----
[%header.monospaced.styled,format=dsv,separator=|]
|===
include::{esql-specs}/ip.csv-spec[tag=to_ip-result]
|===
Note that in the example above 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:68: evaluation of [TO_IP(str2)] failed, treating result as null. Only first 20 failures recorded."`
A following header will contain the failure reason and the offending value:
`"java.lang.IllegalArgumentException: 'foo' is not an IP string literal."`