Network functions
Functions related to IP addresses.
ip
You can use this function to create an IP address.
-
Syntax
ip(expression) -
Parameters
Name Type Mandatory Default Constraints Description expression
string expression, ip address
yes
The expression to create a new IP address.
-
Example
1data record(value = "127.0.0.1"),2 record(value = "2001:0db8:0000:0000:0000:8a2e:0370:7334"),3 record(value = "2001:db8::8a2e:370:7334"),4 record(value = "::1"),5 record(value = "317.0.0.1") // invalid IPv46| fieldsAdd ip(value)Query result
value ip(value) 127.0.0.1127.0.0.12001:0db8:0000:0000:0000:8a2e:0370:73342001:0db8::8a2e:0370:73342001:db8::8a2e:370:73342001:0db8::8a2e:0370:7334::1::0001317.0.0.1null
ipIn
This function returns a Boolean which indicates if at least one IP address of the first parameter can be found in the following ones - the same behavior as the in() function.
-
Syntax
ipIn(needle_expressions, haystack_expressions...) -
Parameters
Name Type Mandatory Default Constraints Description needle_expressions
string, ip, array of string expressions/IP addresses
yes
Represents the IP addresses that needs to be found in the haystack_expressions.
haystack_expressions
string, ip, array of string expressions/ip addresses
yes
The variable argument list where the needle_expressions should be found.
-
Example 1
1data record(a = "127.0.0.1", b = "127.0.0.1"),2 record(a = "127.0.0.1", b = "127.0.0.1/8"),3 record(a = "127.0.0.1/8", b = "127.0.0.1"),4 record(a = "127.0.0.1/8", b = "127.0.0.1/16"),5 record(a = array("127.0.0.1", "10.0.0.1"), b = "127.0.0.1"),6 record(a = array("127.0.0.1", "10.0.0.1"), b = array("127.0.0.1/8", "10.0.0.2"))7| fieldsAdd ipIn(a, b)Query result
a b ipIn(a, b) 127.0.0.1127.0.0.1true127.0.0.1127.0.0.1/8true127.0.0.1/8127.0.0.1false127.0.0.1/8127.0.0.1/16false[127.0.0.1, 10.0.0.1]127.0.0.1true[127.0.0.1, 10.0.0.1][127.0.0.1/8, 10.0.0.2]true -
Example 2
1data record(a = ip("127.0.0.1"), b = ip("127.0.0.1")),2 record(a = array(ip("127.0.0.1"), ip("10.0.0.1")), b = ip("127.0.0.1")),3 record(a = array(ip("127.0.0.1"), ip("10.0.0.1")), b = array(ip("127.0.0.1"), ip("10.0.0.2")))4| fieldsAdd ipIn(a, b)Query result
a b ipIn(a, b) 127.0.0.1127.0.0.1true[127.0.0.1, 10.0.0.1]127.0.0.1true[127.0.0.1, 10.0.0.1][127.0.0.1, 10.0.0.2]true -
Example 3
1data record(a = ip("127.0.0.1"), b = "127.0.0.1/8"),2 record(a = array("127.0.0.1", ip("10.0.0.1")), b = "127.0.0.1"),3 record(a = array("127.0.0.1", ip("10.0.0.1")), b = array("127.0.0.1/8", ip("10.0.0.2")))4| fieldsAdd ipIn(a, b)Query result
a b ipIn(a, b) 127.0.0.1127.0.0.1/8true[127.0.0.1, 10.0.0.1]127.0.0.1true[127.0.0.1, 10.0.0.1][127.0.0.1/8, 10.0.0.2]true
IpisLinkLocal
Checks if an IP address is a link-local IP address.
-
Syntax
ipIsLinkLocal(expression) -
Parameters
Name Type Mandatory Default Constraints Description expression
string expression, ip address
yes
The expression to check if it is a particular type of IP address.
-
Example
1data record(a = "169.254.0.0"),2 record(a = "169.254.255.255"),3 record(a = "169.255.0.0")4| fieldsAdd ipIsLinkLocal(a)Query result
a ipIsLinkLocal(a) 169.254.0.0true169.254.255.255true169.255.0.0false
ipIsLoopback
Checks if an IP address is a loopback IP address.
-
Syntax
ipIsLoopback(expression) -
Parameters
Name Type Mandatory Default Constraints Description expression
string expression, ip address
yes
The expression to check if it is a particular type of IP address.
-
Example
1data record(a = "127.0.0.1"),2 record(a = "10.0.0.1"),3 record(a = "::1")4| fieldsAdd ipIsLoopback(a)Query result
a ipIsLoopback(a) 127.0.0.1true10.0.0.1false::1true
ipIsPrivate
Checks if an IP address is a private IP address.
-
Syntax
ipIsPrivate(expression) -
Parameters
Name Type Mandatory Default Constraints Description expression
string expression, ip address
yes
The expression to check if it is a particular type of IP address.
-
Example
1data record(a = "127.0.0.1"),2 record(a = "10.0.0.1"),3 record(a = "::1"),4 record(a = "172.16.1.1"),5 record(a = "1.2.3.4")6| fieldsAdd ipIsPrivate(a)Query result
a ipIsPrivate(a) 127.0.0.1false10.0.0.1true::1false172.16.1.1true1.2.3.4false
ipIsPublic
Checks if an IP address is a public IP address.
-
Syntax
ipIsPublic(expression) -
Parameters
Name Type Mandatory Default Constraints Description expression
string expression, ip address
yes
The expression to check if it is a particular type of IP address.
-
Example
1data record(a = "1.2.3.4"),2 record(a = "2001:0db8:0000:0000:0000:8a2e:0370:7334"),3 record(a = "10.0.0.1"),4 record(a = "::1")5| fieldsAdd ipIsPublic(a)Query result
a ipIsPublic(a) 1.2.3.4true2001:0db8:0000:0000:0000:8a2e:0370:7334true10.0.0.1false::1false
ipMask
Masks an IP address with given bits (optional parameter for IPv6 addresses).
-
Syntax
ipMask(expression, maskBits [, ipv6MaskBits]) -
Parameters
Name Type Mandatory Default Constraints Description expression
string expression, ip address
yes
The expression to check if it is a particular type of IP address.
-
Example
1data record(a = "127.0.0.1"),2 record(a = "10.0.0.1"),3 record(a = "::1"),4 record(a = "172.16.1.1"),5 record(a = "1.2.3.4")6| fieldsAdd ipIsPrivate(a)Query result
a ipIsPrivate(a) 127.0.0.1false10.0.0.1true::1false172.16.1.1true1.2.3.4false
ipIsPublic
Checks if an IP address is a public IP address.
-
Syntax
ipIsPublic(expression) -
Parameters
Name Type Mandatory Default Constraints Description expression
string expression, ip address
yes
The expression to check if it is a particular type of IP address.
-
Example
1data record(a = "1.2.3.4"),2 record(a = "2001:0db8:0000:0000:0000:8a2e:0370:7334"),3 record(a = "10.0.0.1"),4 record(a = "::1")5| fieldsAdd ipIsPublic(a)Query result
a ipIsPublic(a) 1.2.3.4true2001:0db8:0000:0000:0000:8a2e:0370:7334true10.0.0.1false::1false
ipMask
Masks an IP address with given bits (optional parameter for IPv6 addresses).
-
Syntax
ipMask(expression, maskBits [, ipv6MaskBits]) -
Parameters
Name Type Mandatory Default Constraints Description expression
string expression, ip address
yes
-
Example
1data record(a = "127.1.2.3"),2 record(a = "2001:0db8:0000:0000:0000:8a2e:0370:7334")3| fieldsAdd ipMask(a, 8),4 ipMask(a, 16, ipv6MaskBits: 32)Query result
a ipMask(a, 8) ipMask(a, 16, ipv6MaskBits:32) 127.1.2.3127.0.0.0127.1.0.02001:0db8:0000:0000:0000:8a2e:0370:73342000::00002001:0db8::0000
isIp
Checks if an expression is an IPv4/v6 address.
-
Syntax
isIp(expression) -
Parameters
Name Type Mandatory Default Constraints Description expression
string expression, ip address
yes
The expression to check if it contains/produces an IPv4/v6 address.
-
Example
1data record(a = "127.0.0.1"),2 record(a = "127.0.0."),3 record(a = toIp("127.0.0.1")),4 record(a = "2001:0db8:0000:0000:0000:8a2e:0370:7334"),5 record(a = toIp("2001:0db8:0000:0000:0000:8a2e:0370:7334")),6 record(a = "2001:0db8:0000:0000:0000:8a2e:0370:")7| fieldsAdd isIp(a)Query result
a isIp(a) 127.0.0.1true127.0.0.false127.0.0.1true2001:0db8:0000:0000:0000:8a2e:0370:7334true2001:0db8::8a2e:0370:7334true2001:0db8:0000:0000:0000:8a2e:0370:false
isIpV4
Checks if an expression is an IPv4 address.
-
Syntax
isIpV4(expression) -
Parameters
Name Type Mandatory Default Constraints Description expression
string expression, ip address
yes
The expression to check if it contains/produces an IPv4 address.
-
Example
1data record(a = "127.0.0.1"),2 record(a = "127.0.0."),3 record(a = toIp("127.0.0.1")),4 record(a = "2001:0db8:0000:0000:0000:8a2e:0370:7334"),5 record(a = toIp("2001:0db8:0000:0000:0000:8a2e:0370:7334")),6 record(a = "2001:0db8:0000:0000:0000:8a2e:0370:")7| fieldsAdd isIpV4(a)Query result
a isIpV4(a) 127.0.0.1true127.0.0.false127.0.0.1true2001:0db8:0000:0000:0000:8a2e:0370:7334false2001:0db8::8a2e:0370:7334false2001:0db8:0000:0000:0000:8a2e:0370:false
isIpV6
Checks if an expression is an IPv6 address.
-
Syntax
isIpV6(expression) -
Parameters
Name Type Mandatory Default Constraints Description expression
string expression, ip address
yes
The expression to check if it contains/produces an IPv6 address.
-
Example
1data record(a = "127.0.0.1"),2 record(a = "127.0.0."),3 record(a = toIp("127.0.0.1")),4 record(a = "2001:0db8:0000:0000:0000:8a2e:0370:7334"),5 record(a = toIp("2001:0db8:0000:0000:0000:8a2e:0370:7334")),6 record(a = "2001:0db8:0000:0000:0000:8a2e:0370:")7| fieldsAdd isIpV6(a)Query result
a isIpV6(a) 127.0.0.1false127.0.0.false127.0.0.1false2001:0db8:0000:0000:0000:8a2e:0370:7334true2001:0db8::8a2e:0370:7334true2001:0db8:0000:0000:0000:8a2e:0370:false
IP address mathematical operations
-
IP address + numeric
-
IP address + IP address
-
IP address - numeric
-
IP address - IP address
-
Example
1data record(a = toIp("127.0.0.10"), b = toIp("10.0.0.1"))2| fieldsAdd a + b, a - b, a + 1, a - 1Query result
a b a + b a - b a + 1 a - 1 127.0.0.1010.0.0.1137.0.0.11117.0.0.9127.0.0.11127.0.0.9