pyspark.sql.functions.product#

pyspark.sql.functions.product(col)[source]#

Aggregate function: returns the product of the values in a group.

New in version 3.2.0.

Changed in version 3.4.0: Supports Spark Connect.

Parameters

colColumn or column name: column containing values to be multiplied together

Returns

Column or column name: the column for computed results.

Examples

>>> from pyspark.sql import functions as sf
>>> df = spark.sql("SELECT id % 3 AS mod3, id AS value FROM RANGE(10)")
>>> df.groupBy('mod3').agg(sf.product('value')).orderBy('mod3').show()
+----+--------------+
|mod3|product(value)|
+----+--------------+
|   0|           0.0|
|   1|          28.0|
|   2|          80.0|
+----+--------------+