pyspark.sql.functions.sizeΒΆ

pyspark.sql.functions.size(col: ColumnOrName) → pyspark.sql.column.Column[source]ΒΆ

Collection function: returns the length of the array or map stored in the column.

New in version 1.5.0.

Changed in version 3.4.0: Supports Spark Connect.

Parameters
colColumn or str

name of column or expression

Returns
Column

length of the array/map.

Examples

>>> df = spark.createDataFrame([([1, 2, 3],),([1],),([],)], ['data'])
>>> df.select(size(df.data)).collect()
[Row(size(data)=3), Row(size(data)=1), Row(size(data)=0)]