ip_network

Applies to: Databricks Runtime 18.2 and above

Beta

This feature is in Beta. Workspace admins can control access to this feature from the Previews page. See Manage Databricks previews.

Returns the network portion of an IPv4 or IPv6 CIDR block in its canonical form.

This function is aliased by ip_network_first.

For the corresponding SQL function, see ip_network function.

Syntax

Python

from pyspark.databricks.sql import functions as dbf

dbf.ip_network(col=<col>)

Parameters

Parameter	Type	Description
col	pyspark.sql.Column or str	A STRING or BINARY value representing a valid IPv4 or IPv6 CIDR block.

Examples

Example 1: Get network address from an IPv4 CIDR block.

Python

from pyspark.databricks.sql import functions as dbf
df = spark.createDataFrame([('192.168.1.5/24',)], ['cidr'])
df.select(dbf.ip_network('cidr').alias('result')).collect()

Output

[Row(result='192.168.1.0')]

Example 2: Get network address from an IPv6 CIDR block.

Python

from pyspark.databricks.sql import functions as dbf
df = spark.createDataFrame([('2001:db8::1/32',)], ['cidr'])
df.select(dbf.ip_network('cidr').alias('result')).collect()

Output

[Row(result='2001:db8::')]

Example 3: None input returns None.

Python

from pyspark.databricks.sql import functions as dbf
df = spark.createDataFrame([(None,)], 'cidr: string')
df.select(dbf.ip_network('cidr').alias('result')).collect()

Output

[Row(result=None)]