Skip to main content

regexp

Returns true if str matches the Java regex regexp, or false otherwise.

For the corresponding Databricks SQL function, see regexp operator.

Syntax​

Python
from pyspark.sql import functions as dbf

dbf.regexp(str=<str>, regexp=<regexp>)

Parameters​

Parameter

Type

Description

str

pyspark.sql.Column or str

Target column to work on.

regexp

pyspark.sql.Column or str

Regex pattern to apply.

Parameter

Type

Description

str

pyspark.sql.Column or str

Target column to work on.

regexp

pyspark.sql.Column or str

Regex pattern to apply.

Examples​

Python
from pyspark.sql import functions as dbf
spark.createDataFrame(
[("1a 2b 14m", r"(\d+)")], ["str", "regexp"]
).select(dbf.regexp('str', dbf.lit(r'(\d+)'))).show()
Output
+------------------+
|REGEXP(str, (\d+))|
+------------------+
| true|
+------------------+