pyspark.sql.functions.slice(x, start, length)[source]

Collection function: returns an array containing all the elements in x from index start (array indices start at 1, or from the end if start is negative) with the specified length.

New in version 2.4.0.

xColumn or str

the array to be sliced

startColumn or int

the starting index

lengthColumn or int

the length of the slice


>>> df = spark.createDataFrame([([1, 2, 3],), ([4, 5],)], ['x'])
>>>, 2, 2).alias("sliced")).collect()
[Row(sliced=[2, 3]), Row(sliced=[5])]