WIDTH_BUCKET_REGULAR()

All functions > MATH > WIDTH_BUCKET_REGULAR()

Returns the bucket number for a value in equally-spaced buckets within a range.

Signatures

Regular bins

Returns: Bucket number (1-based)

WIDTH_BUCKET_REGULAR(value: T, min_value: T, max_value: T, num_buckets: BIGINT) → BIGINT
sql
ParameterTypeRequiredDescription
valueTYesValue to categorize
min_valueTYesMinimum of the range
max_valueTYesMaximum of the range
num_bucketsBIGINTYesNumber of equal-width buckets

With:

  • T : Floating-point type (FLOAT, DOUBLE)

Signature notes:

  • Creates num_buckets equal-width intervals between min_value and max_value
  • Returns 0 if value < min_value
  • Returns num_buckets + 1 if value >= max_value
  • Returns NULL if value is NULL

Examples

FeatureQL
SELECT
    -- Below range
    f1 := WIDTH_BUCKET(-5E0, 0E0, 100E0, 10),
    -- Bucket 2
    f2 := WIDTH_BUCKET(15E0, 0E0, 100E0, 10),
    -- Bucket 6
    f3 := WIDTH_BUCKET(55E0, 0E0, 100E0, 10),
    -- Above range
    f4 := WIDTH_BUCKET(105E0, 0E0, 100E0, 10)
;
Result
f1 BIGINTf2 BIGINTf3 BIGINTf4 BIGINT
02611

Last update at: 2026/06/20 10:08:10