pyspark.sql.functions.substring

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

子字符串从 pos 开始,长度为 len ,当str是字符串类型时,或者返回从 pos 字节开始,长度为 len 的字节数组切片,当str是二进制类型时。

新增于版本 1.5.0。

在版本 3.4.0 中更改: 支持 Spark Connect。

Parameters
str or str

目标列以进行操作。

pos int

在字符串中的起始位置。

len int

字符长度。

Returns

给定值的子字符串。

注释

位置不是从零开始,而是从1开始索引。

示例

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