Skip to content
DuckDB Extensions All extensions Apache DataSketches

Quantiles functions in the Apache DataSketches DuckDB extension

Function category

Quantiles

14 functions

Classic [mergeable quantile sketch](https://datasketches.apache.org/docs/Quantiles/ClassicQuantilesSketch.html) from the original DataSketches paper. Solid general-purpose choice supporting all numeric types; KLL is now preferred for new projects.

datasketch_quantiles

Aggregate function Quantiles
Signature
datasketch_quantiles(col0: INTEGER, col1: INTEGER | DOUBLE | UINTEGER | …) → <sketch>
Arguments (Positional)
Argument col0 Type INTEGER Mode Positional Description
Argument col1 Type INTEGER | DOUBLE | UINTEGER | …
20 concrete types
BIGINTDOUBLEFLOATINTEGERSMALLINTTINYINTUBIGINTUINTEGERUSMALLINTUTINYINTsketch_quantiles_bigintsketch_quantiles_doublesketch_quantiles_floatsketch_quantiles_integersketch_quantiles_smallintsketch_quantiles_tinyintsketch_quantiles_ubigintsketch_quantiles_uintegersketch_quantiles_usmallintsketch_quantiles_utinyint
Mode Positional Description
Return type varies by input — 10 concrete types
sketch_quantiles_bigintsketch_quantiles_doublesketch_quantiles_floatsketch_quantiles_integersketch_quantiles_smallintsketch_quantiles_tinyintsketch_quantiles_ubigintsketch_quantiles_uintegersketch_quantiles_usmallintsketch_quantiles_utinyint
Description

Aggregate input values into the classic mergeable quantiles sketch from the original DataSketches paper. Solid general-purpose choice supporting all numeric input types; for new projects prefer datasketch_kll, which gives the same merge semantics with better accuracy/size trade-off.

1 Example 1 
SELECT datasketch_quantiles(k, data);
Related functions

datasketch_quantiles_cdf

Scalar function Quantiles
Signature
datasketch_quantiles_cdf( col0: <sketch>, col1: <numeric>[], col2: BOOLEAN ) → <numeric>[]
Arguments (Positional)
Argument col0 Type <sketch>
10 concrete types
sketch_quantiles_bigintsketch_quantiles_doublesketch_quantiles_floatsketch_quantiles_integersketch_quantiles_smallintsketch_quantiles_tinyintsketch_quantiles_ubigintsketch_quantiles_uintegersketch_quantiles_usmallintsketch_quantiles_utinyint
Mode Positional Description
Argument col1 Type <numeric>[]
10 concrete types
BIGINT[]DOUBLE[]FLOAT[]INTEGER[]SMALLINT[]TINYINT[]UBIGINT[]UINTEGER[]USMALLINT[]UTINYINT[]
Mode Positional Description
Argument col2 Type BOOLEAN Mode Positional Description
Return type varies by input — 10 concrete types
BIGINT[]DOUBLE[]FLOAT[]INTEGER[]SMALLINT[]TINYINT[]UBIGINT[]UINTEGER[]USMALLINT[]UTINYINT[]
Description

Return the Cumulative Distribution Function (CDF) of the sketch for a series of points

1 Example 1 
SELECT datasketch_quantiles_cdf(sketch, points, inclusive);
Related functions

datasketch_quantiles_describe

Scalar function Quantiles
Signature
datasketch_quantiles_describe( col0: <sketch>, col1: BOOLEAN, col2: BOOLEAN ) → VARCHAR
Arguments (Positional)
Argument col0 Type <sketch>
10 concrete types
sketch_quantiles_bigintsketch_quantiles_doublesketch_quantiles_floatsketch_quantiles_integersketch_quantiles_smallintsketch_quantiles_tinyintsketch_quantiles_ubigintsketch_quantiles_uintegersketch_quantiles_usmallintsketch_quantiles_utinyint
Mode Positional Description
Argument col1 Type BOOLEAN Mode Positional Description
Argument col2 Type BOOLEAN Mode Positional Description
Description

Return a description of this sketch

1 Example 1 
SELECT datasketch_quantiles_describe(sketch, include_levels, include_items);
Related functions

datasketch_quantiles_is_empty

Scalar function Quantiles
Signature
datasketch_quantiles_is_empty(col0: <sketch>) → BOOLEAN
Arguments (Positional)
Argument col0 Type <sketch>
10 concrete types
sketch_quantiles_bigintsketch_quantiles_doublesketch_quantiles_floatsketch_quantiles_integersketch_quantiles_smallintsketch_quantiles_tinyintsketch_quantiles_ubigintsketch_quantiles_uintegersketch_quantiles_usmallintsketch_quantiles_utinyint
Mode Positional Description
Description

Return a boolean indicating if the sketch is empty

1 Example 1 
SELECT datasketch_quantiles_is_empty(sketch);
Related functions

datasketch_quantiles_is_estimation_mode

Scalar function Quantiles
Signature
datasketch_quantiles_is_estimation_mode(col0: <sketch>) → BOOLEAN
Arguments (Positional)
Argument col0 Type <sketch>
10 concrete types
sketch_quantiles_bigintsketch_quantiles_doublesketch_quantiles_floatsketch_quantiles_integersketch_quantiles_smallintsketch_quantiles_tinyintsketch_quantiles_ubigintsketch_quantiles_uintegersketch_quantiles_usmallintsketch_quantiles_utinyint
Mode Positional Description
Description

Return a boolean indicating if the sketch is in estimation mode

1 Example 1 
SELECT datasketch_quantiles_is_estimation_mode(sketch);
Related functions

datasketch_quantiles_k

Scalar function Quantiles
Signature
datasketch_quantiles_k(col0: <sketch>) → USMALLINT
Arguments (Positional)
Argument col0 Type <sketch>
10 concrete types
sketch_quantiles_bigintsketch_quantiles_doublesketch_quantiles_floatsketch_quantiles_integersketch_quantiles_smallintsketch_quantiles_tinyintsketch_quantiles_ubigintsketch_quantiles_uintegersketch_quantiles_usmallintsketch_quantiles_utinyint
Mode Positional Description
Description

Return the value of K for this sketch

1 Example 1 
SELECT datasketch_quantiles_k(sketch);
Related functions

datasketch_quantiles_max_item

Scalar function Quantiles
Signature
datasketch_quantiles_max_item(col0: <sketch>) → <numeric>
Arguments (Positional)
Argument col0 Type <sketch>
10 concrete types
sketch_quantiles_bigintsketch_quantiles_doublesketch_quantiles_floatsketch_quantiles_integersketch_quantiles_smallintsketch_quantiles_tinyintsketch_quantiles_ubigintsketch_quantiles_uintegersketch_quantiles_usmallintsketch_quantiles_utinyint
Mode Positional Description
Return type varies by input — 10 concrete types
BIGINTDOUBLEFLOATINTEGERSMALLINTTINYINTUBIGINTUINTEGERUSMALLINTUTINYINT
Description

Return the maxium item in the sketch

1 Example 1 
SELECT datasketch_quantiles_max_item(sketch);
Related functions

datasketch_quantiles_min_item

Scalar function Quantiles
Signature
datasketch_quantiles_min_item(col0: <sketch>) → <numeric>
Arguments (Positional)
Argument col0 Type <sketch>
10 concrete types
sketch_quantiles_bigintsketch_quantiles_doublesketch_quantiles_floatsketch_quantiles_integersketch_quantiles_smallintsketch_quantiles_tinyintsketch_quantiles_ubigintsketch_quantiles_uintegersketch_quantiles_usmallintsketch_quantiles_utinyint
Mode Positional Description
Return type varies by input — 10 concrete types
BIGINTDOUBLEFLOATINTEGERSMALLINTTINYINTUBIGINTUINTEGERUSMALLINTUTINYINT
Description

Return the minimum item in the sketch

1 Example 1 
SELECT datasketch_quantiles_min_item(sketch);
Related functions

datasketch_quantiles_n

Scalar function Quantiles
Signature
datasketch_quantiles_n(col0: <sketch>) → UBIGINT
Arguments (Positional)
Argument col0 Type <sketch>
10 concrete types
sketch_quantiles_bigintsketch_quantiles_doublesketch_quantiles_floatsketch_quantiles_integersketch_quantiles_smallintsketch_quantiles_tinyintsketch_quantiles_ubigintsketch_quantiles_uintegersketch_quantiles_usmallintsketch_quantiles_utinyint
Mode Positional Description
Description

Return the number of items contained in the sketch

1 Example 1 
SELECT datasketch_quantiles_rank(sketch);
Related functions

datasketch_quantiles_normalized_rank_error

Scalar function Quantiles
Signature
datasketch_quantiles_normalized_rank_error(col0: <sketch>, col1: BOOLEAN) → DOUBLE
Arguments (Positional)
Argument col0 Type <sketch>
10 concrete types
sketch_quantiles_bigintsketch_quantiles_doublesketch_quantiles_floatsketch_quantiles_integersketch_quantiles_smallintsketch_quantiles_tinyintsketch_quantiles_ubigintsketch_quantiles_uintegersketch_quantiles_usmallintsketch_quantiles_utinyint
Mode Positional Description
Argument col1 Type BOOLEAN Mode Positional Description
Description

Return the normalized rank error of the sketch

1 Example 1 
SELECT datasketch_quantiles_normalized_rank_error(sketch, is_pmf);
Related functions

datasketch_quantiles_num_retained

Scalar function Quantiles
Signature
datasketch_quantiles_num_retained(col0: <sketch>) → UBIGINT
Arguments (Positional)
Argument col0 Type <sketch>
10 concrete types
sketch_quantiles_bigintsketch_quantiles_doublesketch_quantiles_floatsketch_quantiles_integersketch_quantiles_smallintsketch_quantiles_tinyintsketch_quantiles_ubigintsketch_quantiles_uintegersketch_quantiles_usmallintsketch_quantiles_utinyint
Mode Positional Description
Description

Return the number of retained items in the sketch

1 Example 1 
SELECT datasketch_quantiles_num_retained(sketch);
Related functions

datasketch_quantiles_pmf

Scalar function Quantiles
Signature
datasketch_quantiles_pmf( col0: <sketch>, col1: <numeric>[], col2: BOOLEAN ) → <numeric>[]
Arguments (Positional)
Argument col0 Type <sketch>
10 concrete types
sketch_quantiles_bigintsketch_quantiles_doublesketch_quantiles_floatsketch_quantiles_integersketch_quantiles_smallintsketch_quantiles_tinyintsketch_quantiles_ubigintsketch_quantiles_uintegersketch_quantiles_usmallintsketch_quantiles_utinyint
Mode Positional Description
Argument col1 Type <numeric>[]
10 concrete types
BIGINT[]DOUBLE[]FLOAT[]INTEGER[]SMALLINT[]TINYINT[]UBIGINT[]UINTEGER[]USMALLINT[]UTINYINT[]
Mode Positional Description
Argument col2 Type BOOLEAN Mode Positional Description
Return type varies by input — 10 concrete types
BIGINT[]DOUBLE[]FLOAT[]INTEGER[]SMALLINT[]TINYINT[]UBIGINT[]UINTEGER[]USMALLINT[]UTINYINT[]
Description

Return the Probability Mass Function (PMF) of the sketch for a series of points

1 Example 1 
SELECT datasketch_quantiles_pmf(sketch, points, inclusive);
Related functions

datasketch_quantiles_quantile

Scalar function Quantiles
Signature
datasketch_quantiles_quantile( col0: <sketch>, col1: DOUBLE, col2: BOOLEAN ) → <numeric>
Arguments (Positional)
Argument col0 Type <sketch>
10 concrete types
sketch_quantiles_bigintsketch_quantiles_doublesketch_quantiles_floatsketch_quantiles_integersketch_quantiles_smallintsketch_quantiles_tinyintsketch_quantiles_ubigintsketch_quantiles_uintegersketch_quantiles_usmallintsketch_quantiles_utinyint
Mode Positional Description
Argument col1 Type DOUBLE Mode Positional Description
Argument col2 Type BOOLEAN Mode Positional Description
Return type varies by input — 10 concrete types
BIGINTDOUBLEFLOATINTEGERSMALLINTTINYINTUBIGINTUINTEGERUSMALLINTUTINYINT
Description

Approximate quantile at a given rank from a classic Quantiles sketch.

1 Example 1 
SELECT datasketch_quantiles_rank(sketch, rank, inclusive);
Related functions

datasketch_quantiles_rank

Scalar function Quantiles
Signature
datasketch_quantiles_rank( col0: <sketch>, col1: <numeric>, col2: BOOLEAN ) → DOUBLE
Arguments (Positional)
Argument col0 Type <sketch>
10 concrete types
sketch_quantiles_bigintsketch_quantiles_doublesketch_quantiles_floatsketch_quantiles_integersketch_quantiles_smallintsketch_quantiles_tinyintsketch_quantiles_ubigintsketch_quantiles_uintegersketch_quantiles_usmallintsketch_quantiles_utinyint
Mode Positional Description
Argument col1 Type <numeric>
10 concrete types
BIGINTDOUBLEFLOATINTEGERSMALLINTTINYINTUBIGINTUINTEGERUSMALLINTUTINYINT
Mode Positional Description
Argument col2 Type BOOLEAN Mode Positional Description
Description

Approximate rank of a value within the classic Quantiles sketch.

1 Example 1 
SELECT datasketch_quantiles_rank(sketch, item, inclusive);
Related functions