pyspark.sql.functions.tuple_sketch_summary_integer#

pyspark.sql.functions.tuple_sketch_summary_integer(col, mode=None)[source]#

Returns the aggregated summary value from a Datasketches TupleSketch with integer summaries.

New in version 4.2.0.

Parameters

colColumn or column name: The column containing a binary TupleSketch representation
modeColumn or str, optional: The summary mode: “sum” (default), “min”, “max”, or “alwaysone”

Returns

Column: The aggregated summary value.

See also

pyspark.sql.functions.tuple_sketch_agg_integer()
pyspark.sql.functions.tuple_sketch_estimate_integer()

Examples

>>> from pyspark.sql import functions as sf
>>> df = spark.createDataFrame([(1, 10), (2, 20), (2, 30)], ["key", "value"])
>>> df.agg(sf.tuple_sketch_summary_integer(
...     sf.tuple_sketch_agg_integer("key", "value"))).show()
+--------------------------------------------------------------------------------+
|tuple_sketch_summary_integer(tuple_sketch_agg_integer(key, value, 12, sum), sum)|
+--------------------------------------------------------------------------------+
|                                                                              60|
+--------------------------------------------------------------------------------+