pyspark.sql.functions.array_size

pyspark.sql.functions.array_size(col: ColumnOrName) → pyspark.sql.column.Column

Returns the total number of elements in the array. The function returns null for null input.

New in version 3.5.0.

Parameters

colColumn or str

target column to compute on.

Returns

Column

total number of elements in the array.

Examples

>>> df = spark.createDataFrame([([2, 1, 3],), (None,)], ['data'])
>>> df.select(array_size(df.data).alias('r')).collect()
[Row(r=3), Row(r=None)]

previous

pyspark.sql.functions.array_append

next

pyspark.sql.functions.array_sort