blob: e741b51ae3e124d79d1a7d8008c6441ce081a91b [file] [log] [blame] [view]
---
{
"title": "IPV6_STRING_TO_NUM_OR_NULL",
"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.
-->
## IPV6_STRING_TO_NUM_OR_NULL
IPV6_STRING_TO_NUM_OR_NULL
### Description
#### Syntax
`VARCHAR IPV6_STRING_TO_NUM_OR_NULL(VARCHAR ipv6_string)`
`VARCHAR INET6_ATON(VARCHAR ipv6_string)`
The reverse function of IPv6NumToString, it takes an IP address String and returns an IPv6 address in binary format.
If the input string contains a valid IPv4 address, returns its IPv6 equivalent.
#### Notice
If an illegal IP address is entered, `NULL` is returned. This function has an alias `INET6_ATON`.
### Example
```sql
mysql> select hex(ipv6_string_to_num_or_null('1111::ffff'));
+-----------------------------------------------+
| hex(ipv6_string_to_num_or_null('1111::ffff')) |
+-----------------------------------------------+
| 1111000000000000000000000000FFFF |
+-----------------------------------------------+
1 row in set (0.01 sec)
mysql> select hex(ipv6_string_to_num_or_null('192.168.0.1'));
+------------------------------------------------+
| hex(ipv6_string_to_num_or_null('192.168.0.1')) |
+------------------------------------------------+
| 00000000000000000000FFFFC0A80001 |
+------------------------------------------------+
1 row in set (0.02 sec)
mysql> select hex(ipv6_string_to_num_or_null('notaaddress'));
+------------------------------------------------+
| hex(ipv6_string_to_num_or_null('notaaddress')) |
+------------------------------------------------+
| NULL |
+------------------------------------------------+
1 row in set (0.02 sec)
```
### Keywords
IPV6_STRING_TO_NUM_OR_NULL, INET6_ATON, IP