pyspark.sql.functions.substring¶

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

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.

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')]

pyspark.sql.functions.split pyspark.sql.functions.substring_index