pyspark.sql.functions.kll_sketch_get_n_float#

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

Returns the number of items collected in the KLL float sketch.

Added in version 4.1.0.

Parameters:
colColumn or column name

The KLL float sketch binary representation. A column that evaluates to a binary.

Returns:
Column

The count of items in the sketch. Returns a column that evaluates to a long.

Examples

>>> from pyspark.sql import functions as sf
>>> df = spark.createDataFrame([1.0,2.0,3.0,4.0,5.0], "FLOAT")
>>> sketch_df = df.agg(sf.kll_sketch_agg_float("value").alias("sketch"))
>>> sketch_df.select(sf.kll_sketch_get_n_float("sketch")).show()
+------------------------------+
|kll_sketch_get_n_float(sketch)|
+------------------------------+
|                             5|
+------------------------------+