blob: 5255dfe368bdac97e5fc7646d4240817a6c19d2a [file] [log] [blame] [view]
---
{
"title": "IPV4_STRING_TO_NUM",
"language": "en"
}
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
## IPV4_STRING_TO_NUM
IPV4_STRING_TO_NUM
### Description
#### Syntax
`BIGINT IPV4_STRING_TO_NUM(VARCHAR ipv4_string)`
Takes a string containing an IPv4 address in the format A.B.C.D (dot-separated numbers in decimal form). Returns a BIGINT number representing the corresponding IPv4 address in big endian.
#### Notice
If the input string is not a valid IPv4 address or `NULL`, an error is returned
### Example
```sql
mysql> select ipv4_string_to_num('192.168.0.1');
+-----------------------------------+
| ipv4_string_to_num('192.168.0.1') |
+-----------------------------------+
| 3232235521 |
+-----------------------------------+
1 row in set (0.01 sec)
mysql> select ipv4_string_to_num('invalid');
ERROR 1105 (HY000): errCode = 2, detailMessage = (172.17.0.2)[CANCELLED][INVALID_ARGUMENT][E33] Invalid IPv4 value
mysql> select addr_src, ipv4_string_to_num(addr_src) from ipv4_string_test where addr_src is null;
ERROR 1105 (HY000): errCode = 2, detailMessage = (172.17.0.2)[CANCELLED][E33] Null Input, you may consider convert it to a valid default IPv4 value like '0.0.0.0' first
```
### Keywords
IPV4_STRING_TO_NUM, IP