跳至主要内容

用于处理 IPv4 和 IPv6 地址的函数

IPv4NumToString(num)

接受一个 UInt32 类型的数字。将其解释为大端序的 IPv4 地址。返回一个字符串,包含以 A.B.C.d 格式(以点分隔的十进制形式)表示的对应 IPv4 地址。

别名:INET_NTOA

IPv4StringToNum(s)

IPv4NumToString 的反函数。如果 IPv4 地址格式无效,则会抛出异常。

别名:INET_ATON

IPv4StringToNumOrDefault(s)

IPv4StringToNum 相同,但如果 IPv4 地址格式无效,则返回 0。

IPv4StringToNumOrNull(s)

IPv4StringToNum 相同,但如果 IPv4 地址格式无效,则返回 null。

IPv4NumToStringClassC(num)

类似于 IPv4NumToString,但使用 xxx 代替最后一个字节。

示例

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 │
└────────────────┴───────┘

由于使用 ‘xxx’ 非常不寻常,因此将来可能会更改此功能。我们建议您不要依赖此片段的精确格式。

IPv6NumToString(x)

接受一个包含以二进制格式表示的 IPv6 地址的 FixedString(16) 值。返回一个包含以文本格式表示的该地址的字符串。IPv6 映射的 IPv4 地址将以 ::ffff:111.222.33.44 格式输出。

别名:INET6_NTOA

示例

SELECT IPv6NumToString(toFixedString(unhex('2A0206B8000000000000000000000011'), 16)) AS addr;
┌─addr─────────┐
│ 2a02:6b8::11 │
└──────────────┘
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 │
└─────────────────────────────────────────┴───────┘
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

IPv6NumToString 的反函数。如果 IPv6 地址格式无效,则会抛出异常。

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

别名:INET6_ATON

语法

IPv6StringToNum(string)

参数

返回值

示例

查询

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(s)

IPv6StringToNum 相同,但如果 IPv6 地址格式无效,则返回 0。

IPv6StringToNumOrNull(s)

IPv6StringToNum 相同,但如果 IPv6 地址格式无效,则返回 null。

IPv4ToIPv6(x)

接受一个 UInt32 类型的数字。将其解释为 大端序 的 IPv4 地址。返回一个包含以二进制格式表示的 IPv6 地址的 FixedString(16) 值。示例

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

cutIPv6(x, bytesToCutForIPv6, bytesToCutForIPv4)

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

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 │
└─────────────────────────────────────┴─────────────────────┘

IPv4CIDRToRange(ipv4, Cidr),

接受一个 IPv4 和一个包含 CIDR 的 UInt8 值。返回包含子网的较低范围和较高范围的两个 IPv4 的元组。

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

IPv6CIDRToRange(ipv6, Cidr),

接受一个 IPv6 和一个包含 CIDR 的 UInt8 值。返回包含子网的较低范围和较高范围的两个 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') │
└────────────────────────────────────────────────────────────────────────┘

toIPv4

类似于 IPv4StringToNum,但接受 IPv4 地址的字符串形式,并返回 IPv4 类型的值。

语法

toIPv4(string)

参数

返回值

  • 转换为 IPv4 地址的 stringIPv4.

示例

查询

SELECT toIPv4('171.225.130.45');

结果

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

查询

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 │
└───────────────────────────────────┴──────────────────────────┘

toIPv4OrDefault

toIPv4 相同,但如果 IPv4 地址格式无效,则返回 0.0.0.0(0 IPv4)或提供的 IPv4 默认值。

语法

toIPv4OrDefault(string[, default])

参数

  • value — IP 地址。 字符串.
  • default(可选)— 如果 string 格式无效,则返回的值。 IPv4.

返回值

  • 转换为当前 IPv4 地址的 string字符串.

示例

查询

WITH
'::ffff:127.0.0.1' AS valid_IPv6_string,
'fe80:2030:31:24' AS invalid_IPv6_string
SELECT
toIPv4OrDefault(valid_IPv6_string) AS valid,
toIPv4OrDefault(invalid_IPv6_string) AS default,
toIPv4OrDefault(invalid_IPv6_string, toIPv4('1.1.1.1')) AS provided_default;

结果

┌─valid───┬─default─┬─provided_default─┐
│ 0.0.0.0 │ 0.0.0.0 │ 1.1.1.1 │
└─────────┴─────────┴──────────────────┘

toIPv4OrNull

toIPv4 相同,但如果 IPv4 地址格式无效,则返回 null。

语法

toIPv4OrNull(string)

参数

返回值

  • 转换为当前 IPv4 地址的 string,如果 string 是无效地址,则返回 null。 字符串.

示例

查询

WITH 'fe80:2030:31:24' AS invalid_IPv6_string
SELECT toIPv4OrNull(invalid_IPv6_string);

结果

┌─toIPv4OrNull(invalid_IPv6_string)─┐
│ ᴺᵁᴸᴸ │
└───────────────────────────────────┘

toIPv4OrZero

toIPv4 相同,但如果 IPv4 地址格式无效,则返回 0.0.0.0

语法

toIPv4OrZero(string)

参数

返回值

  • 转换为当前 IPv4 地址的 string,如果 string 是无效地址,则返回 0.0.0.0字符串.

示例

查询

WITH 'Not an IP address' AS invalid_IPv6_string
SELECT toIPv4OrZero(invalid_IPv6_string);

结果

┌─toIPv4OrZero(invalid_IPv6_string)─┐
│ 0.0.0.0 │
└───────────────────────────────────┘

toIPv6

将 IPv6 地址的字符串形式转换为 IPv6 类型。如果 IPv6 地址格式无效,则返回空值。类似于 IPv6StringToNum 函数,该函数将 IPv6 地址转换为二进制格式。

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

语法

toIPv6(string)

参数

返回值

示例

查询

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 │
└───────────────────────────────────┴──────────────────────────────────┘

查询

SELECT toIPv6('127.0.0.1');

结果

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

toIPv6OrDefault

toIPv6 相同,但如果 IPv6 地址格式无效,则返回 ::(0 IPv6)或提供的 IPv6 默认值。

语法

toIPv6OrDefault(string[, default])

参数

  • string — IP 地址。 字符串.
  • default(可选)— 如果 string 格式无效,则返回的值。 IPv6.

返回值

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

示例

查询

WITH
'127.0.0.1' AS valid_IPv4_string,
'127.0.0.1.6' AS invalid_IPv4_string
SELECT
toIPv6OrDefault(valid_IPv4_string) AS valid,
toIPv6OrDefault(invalid_IPv4_string) AS default,
toIPv6OrDefault(invalid_IPv4_string, toIPv6('1.1.1.1')) AS provided_default

结果

┌─valid────────────┬─default─┬─provided_default─┐
│ ::ffff:127.0.0.1 │ :: │ ::ffff:1.1.1.1 │
└──────────────────┴─────────┴──────────────────┘

toIPv6OrNull

toIPv6 相同,但如果 IPv6 地址格式无效,则返回 null。

语法

toIPv6OrNull(string)

参数

返回值

  • IP 地址。 IPv6,如果 string 格式无效,则返回 null。

示例

查询

WITH '127.0.0.1.6' AS invalid_IPv4_string
SELECT toIPv6OrNull(invalid_IPv4_string);

结果

┌─toIPv6OrNull(invalid_IPv4_string)─┐
│ ᴺᵁᴸᴸ │
└───────────────────────────────────┘

toIPv6OrZero

toIPv6 相同,但如果 IPv6 地址格式无效,则返回 ::

语法

toIPv6OrZero(string)

参数

返回值

  • IP 地址。 IPv6,如果 string 格式无效,则返回 ::

示例

查询

WITH '127.0.0.1.6' AS invalid_IPv4_string
SELECT toIPv6OrZero(invalid_IPv4_string);

结果

┌─toIPv6OrZero(invalid_IPv4_string)─┐
│ :: │
└───────────────────────────────────┘

IPv6StringToNumOrDefault(s)

toIPv6 相同,但如果 IPv6 地址格式无效,则返回 0。

IPv6StringToNumOrNull(s)

toIPv6 相同,但如果 IPv6 地址格式无效,则返回 null。

isIPv4String

确定输入字符串是否为 IPv4 地址。如果 string 是 IPv6 地址,则返回 0

语法

isIPv4String(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

判断输入字符串是否为 IPv6 地址。如果 `string` 是 IPv4 地址,则返回 `0`。

语法

isIPv6String(string)

参数

返回值

  • 如果 `string` 是 IPv6 地址,则返回 `1`,否则返回 `0`。 UInt8.

示例

查询

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 │
└──────────────────┴────────────────────┘

isIPAddressInRange

确定一个 IP 地址是否包含在使用 CIDR 符号表示的网络中。如果为真,则返回 `1`,否则返回 `0`。

语法

isIPAddressInRange(address, prefix)

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

参数

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

返回值

示例

查询

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

结果

┌─isIPAddressInRange('127.0.0.1', '127.0.0.0/8')─┐
│ 1 │
└────────────────────────────────────────────────┘

查询

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

结果

┌─isIPAddressInRange('127.0.0.1', 'ffff::/16')─┐
│ 0 │
└──────────────────────────────────────────────┘

查询

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

结果

┌─isIPAddressInRange('::ffff:192.168.0.1', '::ffff:192.168.0.4/128')─┐
│ 0 │
└────────────────────────────────────────────────────────────────────┘