pyspark.sql.functions.locate

pyspark.sql.functions.locate(substr: str, str: ColumnOrName, pos: int = 1) → pyspark.sql.column.Column

Locate the position of the first occurrence of substr in a string column, after position pos.

New in version 1.5.0.

Changed in version 3.4.0: Supports Spark Connect.

Parameters

substrstr

a string

strColumn or str

a Column of pyspark.sql.types.StringType

posint, optional

start position (zero based)

Returns

Column

position of the substring.

Notes

The position is not zero based, but 1 based index. Returns 0 if substr could not be found in str.

Examples

>>> df = spark.createDataFrame([('abcd',)], ['s',])
>>> df.select(locate('b', df.s, 1).alias('s')).collect()
[Row(s=2)]

previous

pyspark.sql.functions.levenshtein

next

pyspark.sql.functions.lpad