pyspark.sql.functions.regexp#

pyspark.sql.functions.regexp(str, regexp)[source]#

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

Added in version 3.5.0.

Parameters:

strColumn or str: target column to work on. A column that evaluates to a string.
regexpColumn or str: regex pattern to apply. A column that evaluates to a string.

Returns:

Column: true if str matches a Java regex, or false otherwise. Returns a column that evaluates to a boolean.

See also

pyspark.sql.functions.rlike()
pyspark.sql.functions.regexp_like()
pyspark.sql.functions.like()
pyspark.sql.functions.ilike()

Examples

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

>>> import pyspark.sql.functions as sf
>>> spark.createDataFrame(
...     [("1a 2b 14m", r"(\d+)")], ["str", "regexp"]
... ).select(sf.regexp('str', sf.lit(r'\d{2}b'))).show()
+-------------------+
|REGEXP(str, \d{2}b)|
+-------------------+
|              false|
+-------------------+

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