跳到主要内容
跳到主要内容

函数用于处理IPv4和IPv6地址

IPv4CIDRToRange

引入于:v20.1

接受带有无类域间路由 (CIDR) 前缀长度的IPv4地址,返回该子网的地址范围,作为两个IPv4值的元组:该子网中的第一个和最后一个地址。 IPv6版本请参见 IPv6CIDRToRange

语法

IPv4CIDRToRange(ipv4, cidr)

参数

返回值

返回一个包含两个IPv4地址的元组,表示子网范围。 Tuple(IPv4, IPv4)

示例

用法示例

SELECT IPv4CIDRToRange(toIPv4('192.168.5.2'), 16);
┌─IPv4CIDRToRange(toIPv4('192.168.5.2'), 16)─┐
│ ('192.168.0.0','192.168.255.255')          │
└────────────────────────────────────────────┘

IPv4NumToString

引入于:v1.1

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

语法

IPv4NumToString(num)

参数

  • num — IPv4地址作为UInt32数字。 UInt32

返回值

返回代表MAC地址的数字,或如果格式无效则返回0String

示例

用法示例

IPv4NumToString(3232235521)
192.168.0.1

IPv4NumToStringClassC

引入于:v1.1

将32位整数转换为其在点分十进制表示法中的IPv4地址字符串表示 (A.B.C.D格式), 类似于 IPv4NumToString,但使用xxx替代最后一个八位组。

语法

IPv4NumToStringClassC(num)

参数

  • num — IPv4地址作为UInt32数字。 UInt32

返回值

返回IPv4地址字符串,用xxx替代最后一个八位组。 String

示例

基本示例与聚合

SELECT
    IPv4NumToStringClassC(ClientIP) AS k,
    count() AS c
FROM test.hits
GROUP BY k
ORDER BY c DESC
LIMIT 10
┌─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 │
└────────────────┴───────┘

IPv4StringToNum

引入于:v1.1

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

语法

IPv4StringToNum(string)

参数

  • string — IPv4地址字符串。 String

返回值

返回IPv4地址。 UInt32

示例

用法示例

IPv4StringToNum('192.168.0.1')
3232235521

IPv4StringToNumOrDefault

引入于:v22.3

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

语法

IPv4StringToNumOrDefault(string)

参数

  • string — IPv4地址字符串。 String

返回值

返回IPv4地址,如果无效则返回0UInt32

示例

带有无效地址的示例

SELECT
    IPv4StringToNumOrDefault('127.0.0.1') AS valid,
    IPv4StringToNumOrDefault('invalid') AS invalid;
┌──────valid─┬─invalid─┐
│ 2130706433 │       0 │
└────────────┴─────────┘

IPv4StringToNumOrNull

引入于:v22.3

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

语法

IPv4StringToNumOrNull(string)

参数

  • string — IPv4地址字符串。 String

返回值

返回IPv4地址,如果无效则返回NULLNullable(UInt32)

示例

带有无效地址的示例

SELECT
IPv4StringToNumOrNull('127.0.0.1') AS valid,
IPv4StringToNumOrNull('invalid') AS invalid;
┌──────valid─┬─invalid─┐
│ 2130706433 │    ᴺᵁᴸᴸ │
└────────────┴─────────┘

IPv4ToIPv6

引入于:v1.1

将一个(大端)32位数字解释为IPv4地址,然后将其解释为对应的IPv6地址,以FixedString(16)格式表示。

语法

IPv4ToIPv6(x)

参数

返回值

返回以二进制格式表示的IPv6地址。 FixedString(16)

示例

用法示例

SELECT IPv6NumToString(IPv4ToIPv6(IPv4StringToNum('192.168.0.1'))) AS addr;
┌─addr───────────────┐
│ ::ffff:192.168.0.1 │
└────────────────────┘

IPv6CIDRToRange

引入于:v20.1

接受带有无类域间路由 (CIDR) 前缀长度的IPv6地址,返回该子网的地址范围,作为两个IPv6值的元组:该子网中的最低和最高地址。 IPv4版本请参见 IPv4CIDRToRange

语法

IPv6CIDRToRange(ipv6, cidr)

参数

返回值

返回一个包含两个IPv6地址的元组,表示子网范围。 Tuple(IPv6, IPv6)

示例

用法示例

SELECT IPv6CIDRToRange(toIPv6('2001:0db8:0000:85a3:0000:0000:ac1f:8001'), 32);
┌─IPv6CIDRToRange(toIPv6('2001:0db8:0000:85a3:0000:0000:ac1f:8001'), 32)─┐
│ ('2001:db8::','2001:db8:ffff:ffff:ffff:ffff:ffff:ffff')                │
└────────────────────────────────────────────────────────────────────────┘

IPv6NumToString

引入于:v1.1

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

语法

IPv6NumToString(x)

参数

返回值

返回以文本格式表示的IPv6地址。 String

示例

用法示例

SELECT IPv6NumToString(toFixedString(unhex('2A0206B8000000000000000000000011'), 16)) AS addr;
┌─addr─────────┐
│ 2a02:6b8::11 │
└──────────────┘

带有命中分析的IPv6

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
┌─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地址

SELECT
    IPv6NumToString(ClientIP6 AS k),
    count() AS c
FROM hits_all
WHERE EventDate = today()
GROUP BY k
ORDER BY c DESC
LIMIT 10
┌─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 │
└────────────────────────────┴────────┘

IPv6StringToNum

引入于:v1.1

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

如果输入字符串包含有效IPv4地址,则返回其IPv6等效地址。 HEX可以是大写或小写。

语法

IPv6StringToNum(string)

参数

  • string — IPv6地址字符串。 String

返回值

返回以二进制格式表示的IPv6地址。 FixedString(16)

示例

基本示例

SELECT addr, cutIPv6(IPv6StringToNum(addr), 0, 0) FROM (SELECT ['notaddress', '127.0.0.1', '1111::ffff'] AS addr) ARRAY JOIN addr;
┌─addr───────┬─cutIPv6(IPv6StringToNum(addr), 0, 0)─┐
│ notaddress │ ::                                   │
│ 127.0.0.1  │ ::ffff:127.0.0.1                     │
│ 1111::ffff │ 1111::ffff                           │
└────────────┴──────────────────────────────────────┘

IPv6StringToNumOrDefault

引入于:v22.3

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

语法

IPv6StringToNumOrDefault(string)

参数

  • string — IPv6地址字符串。 String

返回值

返回以二进制格式表示的IPv6地址,如果无效则返回零填充的FixedString(16)。 FixedString(16)

示例

带有无效地址的基本示例

SELECT
    IPv6NumToString(IPv6StringToNumOrDefault('2001:db8::1')) AS valid,
    IPv6NumToString(IPv6StringToNumOrDefault('invalid')) AS invalid;
┌─valid───────┬─invalid─┐
│ 2001:db8::1 │ ::      │
└─────────────┴─────────┘

IPv6StringToNumOrNull

引入于:v22.3

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

语法

IPv6StringToNumOrNull(string)

参数

  • string — IPv6地址字符串。 String

返回值

返回以二进制格式表示的IPv6地址,如果无效则返回NULLNullable(FixedString(16))

示例

带有无效地址的基本示例

SELECT
    IPv6NumToString(IPv6StringToNumOrNull('2001:db8::1')) AS valid,
    IPv6StringToNumOrNull('invalid') AS invalid;
┌─valid───────┬─invalid─┐
│ 2001:db8::1 │    ᴺᵁᴸᴸ │
└─────────────┴─────────┘

cutIPv6

引入于:v1.1

接受包含二进制格式中的IPv6地址的 FixedString(16) 值。 返回包含指定字节数移除的文本格式地址的字符串。

语法

cutIPv6(x, bytesToCutForIPv6, bytesToCutForIPv4)

参数

  • x — 二进制格式的IPv6地址。 FixedString(16)IPv6
  • bytesToCutForIPv6 — 需要移除的IPv6字节数。 UInt8
  • bytesToCutForIPv4 — 需要移除的IPv4字节数。 UInt8

返回值

返回以文本格式表示的IPv6地址字符串,移除了指定的字节。 String

示例

用法示例

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)
┌─cutIPv6(ipv6, 2, 0)─────────────────┬─cutIPv6(ipv4, 0, 2)─┐
│ 2001:db8:ac10:fe01:feed:babe:cafe:0 │ ::ffff:192.168.0.0  │
└─────────────────────────────────────┴─────────────────────┘

isIPAddressInRange

引入于:v21.4

判断一个IP地址是否包含在以无类域间路由 (CIDR)表示的网络中。

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

语法

isIPAddressInRange(address, prefix)

参数

  • address — IPv4或IPv6地址。 String
  • prefix — 表示CIDR的IPv4或IPv6网络前缀。 String

返回值

如果地址的IP版本与CIDR匹配,则返回1,否则返回0UInt8

示例

在范围内的IPv4地址

SELECT isIPAddressInRange('127.0.0.1', '127.0.0.0/8')
1

不在范围内的IPv4地址

SELECT isIPAddressInRange('127.0.0.1', 'ffff::/16')
0

不在范围内的IPv6地址

SELECT isIPAddressInRange('::ffff:192.168.0.1', '::ffff:192.168.0.4/128')
0

isIPv4String

引入于:v21.1

判断输入字符串是否为IPv4地址。 IPv6版本请参见 isIPv6String

语法

isIPv4String(string)

参数

  • string — 要检查的IP地址字符串。 String

返回值

如果string为IPv4地址则返回1,否则返回0UInt8

示例

用法示例

SELECT addr, isIPv4String(addr)
FROM(
SELECT ['0.0.0.0', '127.0.0.1', '::ffff:127.0.0.1'] AS addr
)
ARRAY JOIN addr;
┌─addr─────────────┬─isIPv4String(addr)─┐
│ 0.0.0.0          │                  1 │
│ 127.0.0.1        │                  1 │
│ ::ffff:127.0.0.1 │                  0 │
└──────────────────┴────────────────────┘

isIPv6String

引入于:v21.1

判断输入字符串是否为IPv6地址。 IPv4版本请参见 isIPv4String

语法

isIPv6String(string)

参数

  • string — 要检查的IP地址字符串。 String

返回值

如果string为IPv6地址则返回1,否则返回0UInt8

示例

用法示例

SELECT addr, isIPv6String(addr)
FROM(SELECT ['::', '1111::ffff', '::ffff:127.0.0.1', '127.0.0.1'] AS addr)
ARRAY JOIN addr;
┌─addr─────────────┬─isIPv6String(addr)─┐
│ ::               │                  1 │
│ 1111::ffff       │                  1 │
│ ::ffff:127.0.0.1 │                  1 │
│ 127.0.0.1        │                  0 │
└──────────────────┴────────────────────┘

toIPv4

引入于:v20.1

将字符串或UInt32形式的IPv4地址转换为IPv4类型。 它类似于IPv4StringToNumIPv4NumToString函数,但它支持字符串和无符号整数数据类型作为输入参数。

语法

toIPv4(x)

参数

返回值

返回IPv4地址。 IPv4

示例

用法示例

SELECT toIPv4('171.225.130.45');
┌─toIPv4('171.225.130.45')─┐
│ 171.225.130.45           │
└──────────────────────────┘

与IPv4StringToNum和IPv4NumToString函数的比较。

WITH
    '171.225.130.45' AS IPv4_string
SELECT
    hex(IPv4StringToNum(IPv4_string)),
    hex(toIPv4(IPv4_string))
┌─hex(IPv4StringToNum(IPv4_string))─┬─hex(toIPv4(IPv4_string))─┐
│ ABE1822D                          │ ABE1822D                 │
└───────────────────────────────────┴──────────────────────────┘

从整数转换

SELECT toIPv4(2130706433);
┌─toIPv4(2130706433)─┐
│ 127.0.0.1          │
└────────────────────┘

toIPv4OrDefault

引入于:v22.3

将字符串或UInt32形式的IPv4地址转换为IPv4类型。 如果IPv4地址格式无效,则返回0.0.0.0 (0 IPv4),或提供的IPv4默认值。

语法

toIPv4OrDefault(string[, default])

参数

  • string — 要转换的IP地址字符串。 String
  • default — 可选。如果字符串为无效IPv4地址时返回的值。 IPv4

返回值

返回当前IPv4地址转换后的字符串,或在转换失败时返回默认值。 IPv4

示例

有效和无效的IPv4字符串

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;
┌─valid─────────┬─default_value─┬─provided_default─┐
│ 192.168.1.1   │ 0.0.0.0       │ 8.8.8.8          │
└───────────────┴───────────────┴──────────────────┘

toIPv4OrNull

引入于:v22.3

将输入值转换为类型IPv4的值,但在发生错误的情况下返回NULL。 类似于 toIPv4,但在转换错误时返回NULL而不是抛出异常。

支持的参数:

  • 点分十进制表示法中的IPv4地址的字符串表示。
  • IPv4地址的整数表示。

不支持的参数(返回NULL):

  • 无效的IP地址格式。
  • IPv6地址。
  • 超出范围的值。
  • 格式错误的地址。

语法

toIPv4OrNull(x)

参数

  • x — IPv4地址的字符串或整数表示。 StringInteger

返回值

如果成功,则返回IPv4地址,否则返回NULLIPv4NULL

示例

用法示例

SELECT
    toIPv4OrNull('192.168.1.1') AS valid_ip,
    toIPv4OrNull('invalid.ip') AS invalid_ip
┌─valid_ip────┬─invalid_ip─┐
│ 192.168.1.1 │       ᴺᵁᴸᴸ │
└─────────────┴────────────┘

toIPv4OrZero

引入于:v23.1

将输入值转换为类型IPv4的值,但在发生错误时返回零IPv4地址。 类似于 toIPv4,但在转换错误时返回零IPv4地址(0.0.0.0)而不是抛出异常。

支持的参数:

  • 点分十进制表示法中的IPv4地址的字符串表示。
  • IPv4地址的整数表示。

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

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

语法

toIPv4OrZero(x)

参数

  • x — IPv4地址的字符串或整数表示。 StringInteger

返回值

如果成功,则返回IPv4地址,否则返回零IPv4地址(0.0.0.0)。 IPv4

示例

用法示例

SELECT
    toIPv4OrZero('192.168.1.1') AS valid_ip,
    toIPv4OrZero('invalid.ip') AS invalid_ip
┌─valid_ip────┬─invalid_ip─┐
│ 192.168.1.1 │ 0.0.0.0    │
└─────────────┴────────────┘

toIPv6

引入于:v20.1

将字符串或 UInt128形式的IPv6地址转换为IPv6类型。 对于字符串,如果IPv6地址格式无效,则返回空值。 类似于IPv6StringToNumIPv6NumToString函数,它们在二进制格式 (即FixedString(16))之间转换IPv6地址。

如果输入字符串包含有效的IPv4地址,则返回该IPv4地址的IPv6等效地址。

语法

toIPv6(x)

参数

返回值

返回IPv6地址。 IPv6

示例

用法示例

WITH '2001:438:ffff::407d:1bc1' AS IPv6_string
SELECT
    hex(IPv6StringToNum(IPv6_string)),
    hex(toIPv6(IPv6_string));
┌─hex(IPv6StringToNum(IPv6_string))─┬─hex(toIPv6(IPv6_string))─────────┐
│ 20010438FFFF000000000000407D1BC1  │ 20010438FFFF000000000000407D1BC1 │
└───────────────────────────────────┴──────────────────────────────────┘

IPv4到IPv6的映射

SELECT toIPv6('127.0.0.1');
┌─toIPv6('127.0.0.1')─┐
│ ::ffff:127.0.0.1    │
└─────────────────────┘

toIPv6OrDefault

引入于:v22.3

将字符串或UInt128形式的IPv6地址转换为IPv6类型。 如果IPv6地址格式无效,则返回:: (0 IPv6)或提供的IPv6默认值。

语法

toIPv6OrDefault(string[, default])

参数

  • string — 要转换的IP地址字符串。 - default — 可选。如果字符串格式无效,则返回的值。

返回值

返回IPv6地址,如果无效则返回::或提供的可选默认值,如果参数string格式无效。 IPv6

示例

有效和无效的IPv6字符串

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;
┌─valid──────────────────────────────────┬─default_value─┬─provided_default─┐
│ 2001:db8:85a3::8a2e:370:7334           │ ::            │ ::1              │
└────────────────────────────────────────┴───────────────┴──────────────────┘

toIPv6OrNull

引入于:v22.3

将输入值转换为类型 IPv6 的值,但在发生错误时返回 NULL。 类似于 toIPv6,但在转换错误时返回 NULL而不是抛出异常。

支持的参数:

  • 标准表示法中IPv6地址的字符串表示。
  • IPv4地址的字符串表示(转换为IPv4映射的IPv6)。
  • IPv6地址的二进制表示。

不支持的参数(返回NULL):

  • 无效的IP地址格式。
  • 格式错误的IPv6地址。
  • 超出范围的值。
  • 格式错误的表示法。

语法

toIPv6OrNull(x)

参数

  • x — 一个IPv6或IPv4地址的字符串表示。 String

返回值

如果成功,则返回IPv6地址,否则返回NULLIPv6NULL

示例

用法示例

SELECT
    toIPv6OrNull('2001:0db8:85a3:0000:0000:8a2e:0370:7334') AS valid_ipv6,
    toIPv6OrNull('invalid::ip') AS invalid_ipv6
┌─valid_ipv6──────────────────────────┬─invalid_ipv6─┐
│ 2001:db8:85a3::8a2e:370:7334        │         ᴺᵁᴸᴸ │
└─────────────────────────────────────┴──────────────┘

toIPv6OrZero

引入于:v23.1

将输入值转换为类型IPv6的值,但在发生错误时返回零IPv6地址。 类似于 toIPv6,但在转换错误时返回零IPv6地址 (::)而不是抛出异常。

支持的参数:

  • 标准表示法中IPv6地址的字符串表示。
  • IPv4地址的字符串表示(转换为IPv4映射的IPv6)。
  • IPv6地址的二进制表示。

不支持的参数(返回零IPv6):

  • 无效的IP地址格式。
  • 格式错误的IPv6地址。
  • 超出范围的值。

语法

toIPv6OrZero(x)

参数

  • x — 一个IPv6或IPv4地址的字符串表示。 String

返回值

如果成功,则返回IPv6地址,否则返回零IPv6地址 (::)。 IPv6

示例

用法示例

SELECT
    toIPv6OrZero('2001:0db8:85a3:0000:0000:8a2e:0370:7334') AS valid_ipv6,
    toIPv6OrZero('invalid::ip') AS invalid_ipv6
┌─valid_ipv6──────────────────────────┬─invalid_ipv6─┐
│ 2001:db8:85a3::8a2e:370:7334        │ ::           │
└─────────────────────────────────────┴──────────────┘