> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-8a08bda2.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> 用于处理 IPv4 和 IPv6 地址的函数文档。

# 处理 IPv4 和 IPv6 地址的函数

{/*AUTOGENERATED_START*/}

<div id="IPv4CIDRToRange">
  ## IPv4CIDRToRange
</div>

引入版本：v20.1.0

接受一个 IPv4 地址及其无类别域间路由 (CIDR) 前缀长度，并以包含两个 IPv4 值的元组形式返回该子网的地址范围：即该子网中的第一个和最后一个地址。
IPv6 版本请参见 [`IPv6CIDRToRange`](#IPv4CIDRToRange)。

**语法**

```sql theme={null}
IPv4CIDRToRange(ipv4, cidr)
```

**参数**

* `ipv4` — IPv4 地址。[`IPv4`](/zh/reference/data-types/ipv4) 或 [`String`](/zh/reference/data-types/string)
* `cidr` — CIDR 值。[`UInt8`](/zh/reference/data-types/int-uint)

**返回值**

返回一个 Tuple，其中包含两个表示子网范围的 IPv4 地址。[`Tuple(IPv4, IPv4)`](/zh/reference/data-types/tuple)

**示例**

**用法示例**

```sql title=Query theme={null}
SELECT IPv4CIDRToRange(toIPv4('192.168.5.2'), 16);
```

```response title=Response theme={null}
┌─IPv4CIDRToRange(toIPv4('192.168.5.2'), 16)─┐
│ ('192.168.0.0','192.168.255.255')          │
└────────────────────────────────────────────┘
```

<div id="IPv4NumToString">
  ## IPv4NumToString
</div>

引入版本：v1.1.0

将 32 位整数转换为采用点分十进制表示法 (A.B.C.D 格式) 的 IPv4 地址字符串表示形式。
使用大端字节序来解释输入。

**语法**

```sql theme={null}
IPv4NumToString(num)
```

**别名**: `INET_NTOA`

**参数**

* `num` — 以 UInt32 表示的 IPv4 地址。[`UInt32`](/zh/reference/data-types/int-uint)

**返回值**

返回表示 MAC 地址的数值；如果格式无效，则返回 `0`。[`String`](/zh/reference/data-types/string)

**示例**

**使用示例**

```sql title=Query theme={null}
IPv4NumToString(3232235521)
```

```response title=Response theme={null}
192.168.0.1
```

<div id="IPv4NumToStringClassC">
  ## IPv4NumToStringClassC
</div>

引入版本：v1.1.0

将 32 位整数转换为采用点分十进制表示法 (A.B.C.D 格式) 的 IPv4 地址字符串表示形式，
类似于 [`IPv4NumToString`](#IPv4NumToString)，但将最后一个八位字节替换为 `xxx`。

**语法**

```sql theme={null}
IPv4NumToStringClassC(num)
```

**参数**

* `num` — 以 UInt32 数值表示的 IPv4 地址。[`UInt32`](/zh/reference/data-types/int-uint)

**返回值**

返回 IPv4 地址字符串，其中最后一个八位字节被替换为 xxx。[`String`](/zh/reference/data-types/string)

**示例**

**带聚合的基础示例**

```sql title=Query theme={null}
SELECT
    IPv4NumToStringClassC(ClientIP) AS k,
    count() AS c
FROM test.hits
GROUP BY k
ORDER BY c DESC
LIMIT 10
```

```response title=Response theme={null}
┌─k──────────────┬─────c─┐
│ 83.149.9.xxx   │ 26238 │
│ 217.118.81.xxx │ 26074 │
│ 213.87.129.xxx │ 25481 │
│ 83.149.8.xxx   │ 24984 │
│ 217.118.83.xxx │ 22797 │
│ 78.25.120.xxx  │ 22354 │
│ 213.87.131.xxx │ 21285 │
│ 78.25.121.xxx  │ 20887 │
│ 188.162.65.xxx │ 19694 │
│ 83.149.48.xxx  │ 17406 │
└────────────────┴───────┘
```

<div id="IPv4StringToNum">
  ## IPv4StringToNum
</div>

引入版本：v1.1.0

将点分十进制表示法 (A.B.C.D 格式) 的 IPv4 地址字符串转换为对应的 32 位整数表示。 (与 [`IPv4NumToString`](#IPv4NumToString) 相反。)
如果 IPv4 地址格式无效，则会抛出异常。

**语法**

```sql theme={null}
IPv4StringToNum(string)
```

**别名**: `INET_ATON`

**参数**

* `string` — IPv4 地址字符串。[`String`](/zh/reference/data-types/string)

**返回值**

返回 IPv4 地址。[`UInt32`](/zh/reference/data-types/int-uint)

**示例**

**使用示例**

```sql title=Query theme={null}
IPv4StringToNum('192.168.0.1')
```

```response title=Response theme={null}
3232235521
```

<div id="IPv4StringToNumOrDefault">
  ## IPv4StringToNumOrDefault
</div>

首次引入版本：v22.3.0

将点分十进制表示法 (A.B.C.D 格式) 的 IPv4 地址字符串转换为对应的 32 位整数表示；如果 IPv4 地址格式无效，则返回 `0`。

**语法**

```sql theme={null}
IPv4StringToNumOrDefault(string)
```

**参数**

* `string` — IPv4 地址的字符串。[`String`](/zh/reference/data-types/string)

**返回值**

返回 IPv4 地址；如果地址无效，则返回 `0`。[`UInt32`](/zh/reference/data-types/int-uint)

**示例**

**无效地址示例**

```sql title=Query theme={null}
SELECT
    IPv4StringToNumOrDefault('127.0.0.1') AS valid,
    IPv4StringToNumOrDefault('invalid') AS invalid;
```

```response title=Response theme={null}
┌──────valid─┬─invalid─┐
│ 2130706433 │       0 │
└────────────┴─────────┘
```

<div id="IPv4StringToNumOrNull">
  ## IPv4StringToNumOrNull
</div>

引入版本：v22.3.0

将 32 位整数转换为采用点分十进制表示法 (A.B.C.D 格式) 的 IPv4 地址字符串表示形式；但如果 IPv4 地址格式无效，则返回 `NULL`。

**语法**

```sql theme={null}
IPv4StringToNumOrNull(string)
```

**参数**

* `string` — IPv4 地址字符串。[`String`](/zh/reference/data-types/string)

**返回值**

返回 IPv4 地址；如果地址无效，则返回 `NULL`。[`Nullable(UInt32)`](/zh/reference/data-types/nullable)

**示例**

**地址无效示例**

```sql title=Query theme={null}
SELECT
IPv4StringToNumOrNull('127.0.0.1') AS valid,
IPv4StringToNumOrNull('invalid') AS invalid;
```

```response title=Response theme={null}
┌──────valid─┬─invalid─┐
│ 2130706433 │    ᴺᵁᴸᴸ │
└────────────┴─────────┘
```

<div id="IPv4ToIPv6">
  ## IPv4ToIPv6
</div>

Introduced in: v1.1.0

将一个 (大端序) 32 位数解释为 IPv4 地址，再将其转换为对应的 `FixedString(16)` 格式 IPv6 地址。

**语法**

```sql theme={null}
IPv4ToIPv6(x)
```

**参数**

* `x` — IPv4 地址。[`UInt32`](/zh/reference/data-types/int-uint)

**返回值**

返回以二进制格式表示的 IPv6 地址。[`FixedString(16)`](/zh/reference/data-types/fixedstring)

**示例**

**使用示例**

```sql title=Query theme={null}
SELECT IPv6NumToString(IPv4ToIPv6(IPv4StringToNum('192.168.0.1'))) AS addr;
```

```response title=Response theme={null}
┌─addr───────────────┐
│ ::ffff:192.168.0.1 │
└────────────────────┘
```

<div id="IPv6CIDRToRange">
  ## IPv6CIDRToRange
</div>

引入版本：v20.1.0

接受一个 IPv6 地址及其无类别域间路由 (CIDR) 前缀长度，并以包含两个 IPv6 值的元组形式返回该子网的地址范围：该子网中的最低地址和最高地址。
IPv4 版本请参见 [`IPv4CIDRToRange`](#IPv4CIDRToRange)。

**语法**

```sql theme={null}
IPv6CIDRToRange(ipv6, cidr)
```

**参数**

* `ipv6` — IPv6 地址。[`IPv6`](/zh/reference/data-types/ipv6) 或 [`String`](/zh/reference/data-types/string)
* `cidr` — CIDR 值。[`UInt8`](/zh/reference/data-types/int-uint)

**返回值**

返回一个包含两个 IPv6 地址的 Tuple，用于表示子网范围。[`Tuple(IPv6, IPv6)`](/zh/reference/data-types/tuple)

**示例**

**使用示例**

```sql title=Query theme={null}
SELECT IPv6CIDRToRange(toIPv6('2001:0db8:0000:85a3:0000:0000:ac1f:8001'), 32);
```

```response title=Response theme={null}
┌─IPv6CIDRToRange(toIPv6('2001:0db8:0000:85a3:0000:0000:ac1f:8001'), 32)─┐
│ ('2001:db8::','2001:db8:ffff:ffff:ffff:ffff:ffff:ffff')                │
└────────────────────────────────────────────────────────────────────────┘
```

<div id="IPv6NumToString">
  ## IPv6NumToString
</div>

引入版本：v1.1.0

将二进制格式 (FixedString(16)) 的 IPv6 地址转换为其标准文本表示。
IPv4 映射的 IPv6 地址显示格式为 `::ffff:111.222.33.44`。

**语法**

```sql theme={null}
IPv6NumToString(x)
```

**别名**: `INET6_NTOA`

**参数**

* `x` — 二进制格式的 IPv6 地址。[`FixedString(16)`](/zh/reference/data-types/fixedstring) 或 [`IPv6`](/zh/reference/data-types/ipv6)

**返回值**

返回文本格式的 IPv6 地址字符串。[`String`](/zh/reference/data-types/string)

**示例**

**使用示例**

```sql title=Query theme={null}
SELECT IPv6NumToString(toFixedString(unhex('2A0206B8000000000000000000000011'), 16)) AS addr;
```

```response title=Response theme={null}
┌─addr─────────┐
│ 2a02:6b8::11 │
└──────────────┘
```

**基于 hits 的 IPv6 分析**

```sql title=Query theme={null}
SELECT
    IPv6NumToString(ClientIP6 AS k),
    count() AS c
FROM hits_all
WHERE EventDate = today() AND substring(ClientIP6, 1, 12) != unhex('00000000000000000000FFFF')
GROUP BY k
ORDER BY c DESC
LIMIT 10
```

```response title=Response theme={null}
┌─IPv6NumToString(ClientIP6)──────────────┬─────c─┐
│ 2a02:2168:aaa:bbbb::2                   │ 24695 │
│ 2a02:2698:abcd:abcd:abcd:abcd:8888:5555 │ 22408 │
│ 2a02:6b8:0:fff::ff                      │ 16389 │
│ 2a01:4f8:111:6666::2                    │ 16016 │
│ 2a02:2168:888:222::1                    │ 15896 │
│ 2a01:7e00::ffff:ffff:ffff:222           │ 14774 │
│ 2a02:8109:eee:ee:eeee:eeee:eeee:eeee    │ 14443 │
│ 2a02:810b:8888:888:8888:8888:8888:8888  │ 14345 │
│ 2a02:6b8:0:444:4444:4444:4444:4444      │ 14279 │
│ 2a01:7e00::ffff:ffff:ffff:ffff          │ 13880 │
└─────────────────────────────────────────┴───────┘
```

**映射为 IPv6 的 IPv4 地址**

```sql title=Query theme={null}
SELECT
    IPv6NumToString(ClientIP6 AS k),
    count() AS c
FROM hits_all
WHERE EventDate = today()
GROUP BY k
ORDER BY c DESC
LIMIT 10
```

```response title=Response theme={null}
┌─IPv6NumToString(ClientIP6)─┬──────c─┐
│ ::ffff:94.26.111.111       │ 747440 │
│ ::ffff:37.143.222.4        │ 529483 │
│ ::ffff:5.166.111.99        │ 317707 │
│ ::ffff:46.38.11.77         │ 263086 │
│ ::ffff:79.105.111.111      │ 186611 │
│ ::ffff:93.92.111.88        │ 176773 │
│ ::ffff:84.53.111.33        │ 158709 │
│ ::ffff:217.118.11.22       │ 154004 │
│ ::ffff:217.118.11.33       │ 148449 │
│ ::ffff:217.118.11.44       │ 148243 │
└────────────────────────────┴────────┘
```

<div id="IPv6StringToNum">
  ## IPv6StringToNum
</div>

引入版本：v1.1.0

将 IPv6 地址从标准文本表示转换为二进制格式 (`FixedString(16)`) 。
接受格式为 `::ffff:111.222.33.44.` 的 IPv4 映射的 IPv6 地址。
如果 IPv6 地址格式无效，则会抛出异常。

如果输入字符串包含有效的 IPv4 地址，则返回其对应的 IPv6 地址。
HEX 可以为大写或小写。

**语法**

```sql theme={null}
IPv6StringToNum(string)
```

**别名**: `INET6_ATON`

**参数**

* `string` — IPv6 地址字符串。[`String`](/zh/reference/data-types/string)

**返回值**

以二进制格式返回 IPv6 地址。[`FixedString(16)`](/zh/reference/data-types/fixedstring)

**示例**

**基本示例**

```sql title=Query theme={null}
SELECT addr, cutIPv6(IPv6StringToNum(addr), 0, 0) FROM (SELECT ['notaddress', '127.0.0.1', '1111::ffff'] AS addr) ARRAY JOIN addr;
```

```response title=Response theme={null}
┌─addr───────┬─cutIPv6(IPv6StringToNum(addr), 0, 0)─┐
│ notaddress │ ::                                   │
│ 127.0.0.1  │ ::ffff:127.0.0.1                     │
│ 1111::ffff │ 1111::ffff                           │
└────────────┴──────────────────────────────────────┘
```

<div id="IPv6StringToNumOrDefault">
  ## IPv6StringToNumOrDefault
</div>

引入版本：v22.3.0

将 IPv6 地址从标准文本表示转换为二进制格式 (`FixedString(16)`) 。
接受格式为 `::ffff:111.222.33.44.` 的 IPv4 映射的 IPv6 地址。
如果 IPv6 地址格式无效，则返回默认值 `::`。

**语法**

```sql theme={null}
IPv6StringToNumOrDefault(string)
```

**参数**

* `string` — IPv6 地址字符串。[`String`](/zh/reference/data-types/string)

**返回值**

二进制格式的 IPv6 地址；如果地址无效，则返回以零填充的 FixedString(16)。[`FixedString(16)`](/zh/reference/data-types/fixedstring)

**示例**

**无效地址的基础示例**

```sql title=Query theme={null}
SELECT
    IPv6NumToString(IPv6StringToNumOrDefault('2001:db8::1')) AS valid,
    IPv6NumToString(IPv6StringToNumOrDefault('invalid')) AS invalid;
```

```response title=Response theme={null}
┌─valid───────┬─invalid─┐
│ 2001:db8::1 │ ::      │
└─────────────┴─────────┘
```

<div id="IPv6StringToNumOrNull">
  ## IPv6StringToNumOrNull
</div>

引入版本：v22.3.0

将 IPv6 地址从标准文本表示形式转换为二进制格式 (`FixedString(16)`) 。
接受格式为 `::ffff:111.222.33.44.` 的 IPv4 映射的 IPv6 地址。
如果 IPv6 地址格式无效，则返回 `NULL`。

**语法**

```sql theme={null}
IPv6StringToNumOrNull(string)
```

**参数**

* `string` — IPv6 地址字符串。[`String`](/zh/reference/data-types/string)

**返回值**

返回二进制格式的 IPv6 地址；如果地址无效，则返回 `NULL`。[`Nullable(FixedString(16))`](/zh/reference/data-types/nullable)

**示例**

**无效地址的基础示例**

```sql title=Query theme={null}
SELECT
    IPv6NumToString(IPv6StringToNumOrNull('2001:db8::1')) AS valid,
    IPv6StringToNumOrNull('invalid') AS invalid;
```

```response title=Response theme={null}
┌─valid───────┬─invalid─┐
│ 2001:db8::1 │    ᴺᵁᴸᴸ │
└─────────────┴─────────┘
```

<div id="cutIPv6">
  ## cutIPv6
</div>

引入版本：v1.1.0

接受一个 `FixedString(16)` 值，其中包含二进制格式的 IPv6 地址。
返回一个字符串，以文本格式表示移除指定字节数后的地址。

**语法**

```sql theme={null}
cutIPv6(x, bytesToCutForIPv6, bytesToCutForIPv4)
```

**参数**

* `x` — 二进制格式的 IPv6 地址。[`FixedString(16)`](/zh/reference/data-types/fixedstring) 或 [`IPv6`](/zh/reference/data-types/ipv6)
* `bytesToCutForIPv6` — 要从 IPv6 中截去的字节数。[`UInt8`](/zh/reference/data-types/int-uint)
* `bytesToCutForIPv4` — 要从 IPv4 中截去的字节数。[`UInt8`](/zh/reference/data-types/int-uint)

**返回值**

返回一个字符串，其中包含删除了指定字节后的文本格式 IPv6 地址。[`String`](/zh/reference/data-types/string)

**示例**

**使用示例**

```sql title=Query theme={null}
WITH
    IPv6StringToNum('2001:0DB8:AC10:FE01:FEED:BABE:CAFE:F00D') AS ipv6,
    IPv4ToIPv6(IPv4StringToNum('192.168.0.1')) AS ipv4
SELECT
    cutIPv6(ipv6, 2, 0),
    cutIPv6(ipv4, 0, 2)
```

```response title=Response theme={null}
┌─cutIPv6(ipv6, 2, 0)─────────────────┬─cutIPv6(ipv4, 0, 2)─┐
│ 2001:db8:ac10:fe01:feed:babe:cafe:0 │ ::ffff:192.168.0.0  │
└─────────────────────────────────────┴─────────────────────┘
```

<div id="isIPAddressInRange">
  ## isIPAddressInRange
</div>

自 v21.4.0 引入

判断某个 IP 地址是否位于以 [无类别域间路由 (CIDR)](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) 表示的网络范围内。

此函数接受以字符串形式表示的 IPv4 和 IPv6 地址 (以及网络) 。如果地址的 IP 版本与 CIDR 不匹配，则返回 `0`。

**语法**

```sql theme={null}
isIPAddressInRange(address, prefix)
```

**参数**

* `address` — IPv4 或 IPv6 地址。[`String`](/zh/reference/data-types/string)
* `prefix` — CIDR 表示法中的 IPv4 或 IPv6 网络前缀。[`String`](/zh/reference/data-types/string)

**返回值**

如果该地址的 IP 版本与 CIDR 一致，则返回 `1`；否则返回 `0`。[`UInt8`](/zh/reference/data-types/int-uint)

**示例**

**范围内的 IPv4 地址**

```sql title=Query theme={null}
SELECT isIPAddressInRange('127.0.0.1', '127.0.0.0/8')
```

```response title=Response theme={null}
1
```

**IPv4 地址超出范围**

```sql title=Query theme={null}
SELECT isIPAddressInRange('127.0.0.1', 'ffff::/16')
```

```response title=Response theme={null}
0
```

**IPv6 地址不在范围内**

```sql title=Query theme={null}
SELECT isIPAddressInRange('::ffff:192.168.0.1', '::ffff:192.168.0.4/128')
```

```response title=Response theme={null}
0
```

<div id="isIPv4String">
  ## isIPv4String
</div>

首次引入版本：v21.1.0

判断输入字符串是否为 IPv4 地址。
IPv6 版本请参见 [`isIPv6String`](#isIPv6String)。

**语法**

```sql theme={null}
isIPv4String(string)
```

**参数**

* `string` — 要检查的 IP 地址字符串。[`String`](/zh/reference/data-types/string)

**返回值**

如果 `string` 是 IPv4 地址，则返回 `1`；否则返回 `0`。[`UInt8`](/zh/reference/data-types/int-uint)

**示例**

**使用示例**

```sql title=Query theme={null}
SELECT addr, isIPv4String(addr)
FROM(
SELECT ['0.0.0.0', '127.0.0.1', '::ffff:127.0.0.1'] AS addr
)
ARRAY JOIN addr;
```

```response title=Response theme={null}
┌─addr─────────────┬─isIPv4String(addr)─┐
│ 0.0.0.0          │                  1 │
│ 127.0.0.1        │                  1 │
│ ::ffff:127.0.0.1 │                  0 │
└──────────────────┴────────────────────┘
```

<div id="isIPv6String">
  ## isIPv6String
</div>

首次引入版本：v21.1.0

判断输入字符串是否为 IPv6 地址。
IPv4 版本请参见 [`isIPv4String`](#isIPv4String)。

**语法**

```sql theme={null}
isIPv6String(string)
```

**参数**

* `string` — 要检查的 IP 地址字符串。[`String`](/zh/reference/data-types/string)

**返回值**

如果 `string` 是 IPv6 地址，则返回 `1`；否则返回 `0`。[`UInt8`](/zh/reference/data-types/int-uint)

**示例**

**用法示例**

```sql title=Query theme={null}
SELECT addr, isIPv6String(addr)
FROM(SELECT ['::', '1111::ffff', '::ffff:127.0.0.1', '127.0.0.1'] AS addr)
ARRAY JOIN addr;
```

```response title=Response theme={null}
┌─addr─────────────┬─isIPv6String(addr)─┐
│ ::               │                  1 │
│ 1111::ffff       │                  1 │
│ ::ffff:127.0.0.1 │                  1 │
│ 127.0.0.1        │                  0 │
└──────────────────┴────────────────────┘
```

<div id="toIPv4">
  ## toIPv4
</div>

引入版本：v20.1.0

将 IPv4 地址的字符串或 UInt32 形式转换为 IPv4 类型。
它与 [`IPv4StringToNum`](/zh/reference/functions/regular-functions/ip-address-functions#IPv4StringToNum) 和 [`IPv4NumToString`](/zh/reference/functions/regular-functions/ip-address-functions#IPv4NumToString) 函数类似，但同时支持字符串和无符号整数数据类型作为输入参数。

**语法**

```sql theme={null}
toIPv4(x)
```

**参数**

* `x` — IPv4 地址，类型为 [`String`](/zh/reference/data-types/string) 或 [`UInt8/16/32`](/zh/reference/data-types/int-uint)

**返回值**

返回 IPv4 地址。[`IPv4`](/zh/reference/data-types/ipv4)

**示例**

**使用示例**

```sql title=Query theme={null}
SELECT toIPv4('171.225.130.45');
```

```response title=Response theme={null}
┌─toIPv4('171.225.130.45')─┐
│ 171.225.130.45           │
└──────────────────────────┘
```

**与 IPv4StringToNum 和 IPv4NumToString 函数的对比。**

```sql title=Query theme={null}
WITH
    '171.225.130.45' AS IPv4_string
SELECT
    hex(IPv4StringToNum(IPv4_string)),
    hex(toIPv4(IPv4_string))
```

```response title=Response theme={null}
┌─hex(IPv4StringToNum(IPv4_string))─┬─hex(toIPv4(IPv4_string))─┐
│ ABE1822D                          │ ABE1822D                 │
└───────────────────────────────────┴──────────────────────────┘
```

**从整数值转换**

```sql title=Query theme={null}
SELECT toIPv4(2130706433);
```

```response title=Response theme={null}
┌─toIPv4(2130706433)─┐
│ 127.0.0.1          │
└────────────────────┘
```

<div id="toIPv4OrDefault">
  ## toIPv4OrDefault
</div>

引入版本：v22.3.0

将 IPv4 地址的字符串形式或 UInt32 形式转换为 [`IPv4`](/zh/reference/data-types/ipv4) 类型。
如果 IPv4 地址格式无效，则返回 `0.0.0.0` (即 0 IPv4) ，或者返回提供的默认 IPv4 值。

**语法**

```sql theme={null}
toIPv4OrDefault(string[, default])
```

**参数**

* `string` — 要转换的 IP 地址字符串。[`String`](/zh/reference/data-types/string)
* `default` — 可选。如果字符串不是有效的 IPv4 地址，则返回该值。[`IPv4`](/zh/reference/data-types/ipv4)

**返回值**

返回转换后的 IPv4 地址；如果转换失败，则返回默认值。[`IPv4`](/zh/reference/data-types/ipv4)

**示例**

**有效和无效的 IPv4 字符串**

```sql title=Query theme={null}
WITH
    '192.168.1.1' AS valid_IPv4_string,
    '999.999.999.999' AS invalid_IPv4_string,
    'not_an_ip' AS malformed_string
SELECT
    toIPv4OrDefault(valid_IPv4_string) AS valid,
    toIPv4OrDefault(invalid_IPv4_string) AS default_value,
    toIPv4OrDefault(malformed_string, toIPv4('8.8.8.8')) AS provided_default;
```

```response title=Response theme={null}
┌─valid─────────┬─default_value─┬─provided_default─┐
│ 192.168.1.1   │ 0.0.0.0       │ 8.8.8.8          │
└───────────────┴───────────────┴──────────────────┘
```

<div id="toIPv4OrNull">
  ## toIPv4OrNull
</div>

引入版本：v22.3.0

将输入值转换为 `IPv4` 类型的值，但如果出错则返回 `NULL`。
与 [`toIPv4`](#toIPv4) 类似，但在转换出错时会返回 `NULL`，而不是抛出异常。

支持的参数：

* 点分十进制格式的 IPv4 地址字符串表示形式。
* IPv4 地址的整数表示形式。

不支持的参数 (返回 `NULL`) ：

* 无效的 IP 地址格式。
* IPv6 地址。
* 超出范围的值。
* 格式不正确的地址。

**语法**

```sql theme={null}
toIPv4OrNull(x)
```

**参数**

* `x` — IPv4 地址的字符串或整数形式。[`String`](/zh/reference/data-types/string) 或 [`Integer`](/zh/reference/data-types/int-uint)

**返回值**

成功时返回 IPv4 地址，否则返回 `NULL`。[`IPv4`](/zh/reference/data-types/ipv4) 或 [`NULL`](/zh/reference/syntax#null)

**示例**

**使用示例**

```sql title=Query theme={null}
SELECT
    toIPv4OrNull('192.168.1.1') AS valid_ip,
    toIPv4OrNull('invalid.ip') AS invalid_ip
```

```response title=Response theme={null}
┌─valid_ip────┬─invalid_ip─┐
│ 192.168.1.1 │       ᴺᵁᴸᴸ │
└─────────────┴────────────┘
```

<div id="toIPv4OrZero">
  ## toIPv4OrZero
</div>

Introduced in: v23.1.0

将输入值转换为 [IPv4](/zh/reference/data-types/ipv4) 类型的值；如果发生错误，则返回零 IPv4 地址。
与 [`toIPv4`](#toIPv4) 类似，但在转换出错时会返回零 IPv4 地址 (`0.0.0.0`) ，而不是抛出异常。

支持的参数：

* 采用点分十进制表示法的 IPv4 地址字符串表示形式。
* IPv4 地址的整数表示形式。

不支持的参数 (返回零 IPv4) ：

* 无效的 IP 地址格式。
* IPv6 地址。
* 超出范围的值。

**Syntax**

```sql theme={null}
toIPv4OrZero(x)
```

**参数**

* `x` — IPv4 地址的字符串或整数表示。[`String`](/zh/reference/data-types/string) 或 [`Integer`](/zh/reference/data-types/int-uint)

**返回值**

成功时返回 IPv4 地址，否则返回零 IPv4 地址 (`0.0.0.0`) 。[`IPv4`](/zh/reference/data-types/ipv4)

**示例**

**使用示例**

```sql title=Query theme={null}
SELECT
    toIPv4OrZero('192.168.1.1') AS valid_ip,
    toIPv4OrZero('invalid.ip') AS invalid_ip
```

```response title=Response theme={null}
┌─valid_ip────┬─invalid_ip─┐
│ 192.168.1.1 │ 0.0.0.0    │
└─────────────┴────────────┘
```

<div id="toIPv6">
  ## toIPv6
</div>

Introduced in: v20.1.0

将字符串或 IPv6 地址的 `UInt128` 形式转换为 [`IPv6`](/zh/reference/data-types/ipv6) 类型。
对于字符串，如果 IPv6 地址格式无效，则返回空值。
与 [`IPv6StringToNum`](/zh/reference/functions/regular-functions/ip-address-functions#IPv6StringToNum) 和 [`IPv6NumToString`](/zh/reference/functions/regular-functions/ip-address-functions#IPv6NumToString) 函数类似，这两个函数用于在 IPv6 地址与二进制格式 (即 `FixedString(16)`) 之间相互转换。

如果输入字符串包含有效的 IPv4 地址，则返回该 IPv4 地址对应的 IPv6 等效形式。

**Syntax**

```sql theme={null}
toIPv6(x)
```

**参数**

* `x` — IP 地址。[`String`](/zh/reference/data-types/string) 或 [`UInt128`](/zh/reference/data-types/int-uint)

**返回值**

返回 IPv6 地址。[`IPv6`](/zh/reference/data-types/ipv6)

**示例**

**用法示例**

```sql title=Query theme={null}
WITH '2001:438:ffff::407d:1bc1' AS IPv6_string
SELECT
    hex(IPv6StringToNum(IPv6_string)),
    hex(toIPv6(IPv6_string));
```

```response title=Response theme={null}
┌─hex(IPv6StringToNum(IPv6_string))─┬─hex(toIPv6(IPv6_string))─────────┐
│ 20010438FFFF000000000000407D1BC1  │ 20010438FFFF000000000000407D1BC1 │
└───────────────────────────────────┴──────────────────────────────────┘
```

**IPv4 到 IPv6 映射**

```sql title=Query theme={null}
SELECT toIPv6('127.0.0.1');
```

```response title=Response theme={null}
┌─toIPv6('127.0.0.1')─┐
│ ::ffff:127.0.0.1    │
└─────────────────────┘
```

<div id="toIPv6OrDefault">
  ## toIPv6OrDefault
</div>

引入版本：v22.3.0

将字符串或 IPv6 地址的 UInt128 形式转换为 [`IPv6`](/zh/reference/data-types/ipv6) 类型。
如果 IPv6 地址的格式无效，则返回 `::` (IPv6 的 0 值) 或提供的默认 IPv6 值。

**语法**

```sql theme={null}
toIPv6OrDefault(string[, default])
```

**参数**

* `string` — 要转换的 IP 地址字符串。 - `default` — 可选。当字符串格式无效时返回的值。

**返回值**

返回 IPv6 地址；如果参数 `string` 的格式无效，则返回 `::` 或所提供的可选默认值。[`IPv6`](/zh/reference/data-types/ipv6)

**示例**

**有效与无效的 IPv6 字符串**

```sql title=Query theme={null}
WITH
    '2001:0db8:85a3:0000:0000:8a2e:0370:7334' AS valid_IPv6_string,
    '2001:0db8:85a3::8a2e:370g:7334' AS invalid_IPv6_string,
    'not_an_ipv6' AS malformed_string
SELECT
    toIPv6OrDefault(valid_IPv6_string) AS valid,
    toIPv6OrDefault(invalid_IPv6_string) AS default_value,
    toIPv6OrDefault(malformed_string, toIPv6('::1')) AS provided_default;
```

```response title=Response theme={null}
┌─valid──────────────────────────────────┬─default_value─┬─provided_default─┐
│ 2001:db8:85a3::8a2e:370:7334           │ ::            │ ::1              │
└────────────────────────────────────────┴───────────────┴──────────────────┘
```

<div id="toIPv6OrNull">
  ## toIPv6OrNull
</div>

引入版本：v22.3.0

将输入值转换为 `IPv6` 类型的值；如果发生错误，则返回 `NULL`。
与 [`toIPv6`](#toIPv6) 类似，但在转换出错时会返回 `NULL`，而不是抛出异常。

支持的参数：

* 标准表示法的 IPv6 地址字符串表示形式。
* IPv4 地址的字符串表示形式 (会转换为 IPv4-mapped IPv6) 。
* IPv6 地址的二进制表示形式。

不支持的参数 (返回 `NULL`) ：

* 无效的 IP 地址格式。
* 格式不正确的 IPv6 地址。
* 超出范围的值。
* 无效的表示法。

**语法**

```sql theme={null}
toIPv6OrNull(x)
```

**参数**

* `x` — IPv6 或 IPv4 地址的字符串表示形式。[`String`](/zh/reference/data-types/string)

**返回值**

成功时返回 IPv6 地址，否则返回 `NULL`。[`IPv6`](/zh/reference/data-types/ipv6) 或 [`NULL`](/zh/reference/syntax#null)

**示例**

**用法示例**

```sql title=Query theme={null}
SELECT
    toIPv6OrNull('2001:0db8:85a3:0000:0000:8a2e:0370:7334') AS valid_ipv6,
    toIPv6OrNull('invalid::ip') AS invalid_ipv6
```

```response title=Response theme={null}
┌─valid_ipv6──────────────────────────┬─invalid_ipv6─┐
│ 2001:db8:85a3::8a2e:370:7334        │         ᴺᵁᴸᴸ │
└─────────────────────────────────────┴──────────────┘
```

<div id="toIPv6OrZero">
  ## toIPv6OrZero
</div>

引入版本：v23.1.0

将输入值转换为 [IPv6](/zh/reference/data-types/ipv6) 类型的值；如果出错，则返回全零 IPv6 地址。
类似于 [`toIPv6`](#toIPv6)，但在转换出错时会返回全零 IPv6 地址 (`::`) ，而不是抛出异常。

支持的参数：

* 标准表示法的 IPv6 地址字符串表示形式。
* IPv4 地址的字符串表示形式 (将转换为 IPv4-mapped IPv6) 。
* IPv6 地址的二进制表示形式。

不支持的参数 (将返回全零 IPv6) ：

* 无效的 IP 地址格式。
* 格式不正确的 IPv6 地址。
* 超出范围的值。

**语法**

```sql theme={null}
toIPv6OrZero(x)
```

**参数**

* `x` — IPv6 或 IPv4 地址的字符串表示形式。[`String`](/zh/reference/data-types/string)

**返回值**

如果成功，返回 IPv6 地址；否则返回全零 IPv6 地址 (`::`) 。[`IPv6`](/zh/reference/data-types/ipv6)

**示例**

**用法示例**

```sql title=Query theme={null}
SELECT
    toIPv6OrZero('2001:0db8:85a3:0000:0000:8a2e:0370:7334') AS valid_ipv6,
    toIPv6OrZero('invalid::ip') AS invalid_ipv6
```

```response title=Response theme={null}
┌─valid_ipv6──────────────────────────┬─invalid_ipv6─┐
│ 2001:db8:85a3::8a2e:370:7334        │ ::           │
└─────────────────────────────────────┴──────────────┘
```