ip_version

Applies to: Databricks Runtime 18.2 and above

Important

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

Returns the IP version (4 or 6) from an IPv4 or IPv6 address or CIDR block.

For the corresponding SQL function, see ip_version function.

Syntax

from pyspark.databricks.sql import functions as dbf

dbf.ip_version(col=<col>)

Parameters

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

Examples

Example 1: Get version from an IPv4 address.

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

[Row(result=4)]

Example 2: Get version from an IPv6 address.

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

[Row(result=6)]

Example 3: Get version from a CIDR block.

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

[Row(result=4)]

Example 4: None input returns None.

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

[Row(result=None)]