width_bucket(value: numeric, min: numeric, max: numeric, num_buckets: int64) -> int64

Construct equi-width histogram by dividing up the range between min and max
with num_buckets buckets, and compute an integer bucket ID for each value. The
value range is left-inclusive and right-exclusive, which is usually represented
as [min, max). The bucket IDs would start from 1 and end with num_buckets.

For out-of-bound values, special bucket IDs are returned: if a value is less
than min, its bucket ID is 0. If a value is greater than or equal to max,
its bucket ID is num_buckets + 1.

The function returns null if any input is null or when min is greater than or
equal to max (the value range is empty).

Domain

This is a scalar function (calculates a single output value for a single input row).

Categories

• Numeric

Examples

Compute the histogram by assigning the value to 10 buckets ranging from 1000 to
2000.

Compute the histogram using the dynamic range determined by the min and max
values. Note that the bucket value can go from 1 to 11, because the values
that match the max will be assigned to bucket 11.