pyspark.sql.functions.substring

pyspark.sql.functions.substring(str: ColumnOrName, pos: int, len: int) → pyspark.sql.column.Column

Substring starts at pos and is of length len when str is String type or returns the slice of byte array that starts at pos in byte and is of length len when str is Binary type.

New in version 1.5.0.

Changed in version 3.4.0: Supports Spark Connect.

Parameters

strColumn or str

target column to work on.

posint

starting position in str.

lenint

length of chars.

Returns

Column

substring of given value.

Notes

The position is not zero based, but 1 based index.

Examples

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

previous

pyspark.sql.functions.substr

next

pyspark.sql.functions.substring_index