Skip to main content

Documentation Index

Fetch the complete documentation index at: https://private-7c7dfe99-page-updates.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
Bitmap functions

Bitmaps can be constructed in two ways. The first way is constructed by aggregation function groupBitmap with -State, the other way is to constructed a bitmap from an Array object.

​
bitmapAnd

Introduced in: v20.1.0 Computes the logical conjunction (AND) of two bitmaps. Syntax 
bitmapAnd(bitmap1, bitmap2)
Arguments Returned value Returns a bitmap containing bits present in both input bitmaps AggregateFunction(groupBitmap, T) Examples Usage example
Query
SELECT bitmapToArray(bitmapAnd(bitmapBuild([1, 2, 3]), bitmapBuild([3, 4, 5]))) AS res;
Response
┌─res─┐
│ [3] │
└─────┘

​
bitmapAndCardinality

Introduced in: v20.1.0 Returns the cardinality of the logical conjunction (AND) of two bitmaps. Syntax 
bitmapAndCardinality(bitmap1, bitmap2)
Arguments Returned value Returns the number of set bits in the intersection of the two bitmaps UInt64 Examples Usage example
Query
SELECT bitmapAndCardinality(bitmapBuild([1,2,3]), bitmapBuild([3,4,5])) AS res;
Response
┌─res─┐
│   1 │
└─────┘

​
bitmapAndnot

Introduced in: v20.1.0 Computes the set difference A AND-NOT B of two bitmaps. Syntax 
bitmapAndnot(bitmap1, bitmap2)
Arguments Returned value Returns a bitmap containing set bits present in the first bitmap but not in the second AggregateFunction(groupBitmap, T) Examples Usage example
Query
SELECT bitmapToArray(bitmapAndnot(bitmapBuild([1, 2, 3]), bitmapBuild([3, 4, 5]))) AS res;
Response
┌─res────┐
│ [1, 2] │
└────────┘

​
bitmapAndnotCardinality

Introduced in: v20.1.0 Returns the cardinality of the AND-NOT operation of two bitmaps. Syntax 
bitmapAndnotCardinality(bitmap1, bitmap2)
Arguments Returned value Returns the number of set bits in the result of bitmap1 AND-NOT bitmap2 UInt64 Examples Usage example
Query
SELECT bitmapAndnotCardinality(bitmapBuild([1,2,3]), bitmapBuild([3,4,5])) AS res;
Response
┌─res─┐
│   2 │
└─────┘

​
bitmapBuild

Introduced in: v20.1.0 Builds a bitmap from an unsigned integer array. It is the opposite of function bitmapToArray. Syntax 
bitmapBuild(array)
Arguments Returned value Returns a bitmap from the provided array AggregateFunction(groupBitmap, T) Examples Usage example
Query
SELECT bitmapBuild([1, 2, 3, 4, 5]) AS res, toTypeName(res);
Response
┌─res─┬─toTypeName(bitmapBuild([1, 2, 3, 4, 5]))─────┐
│     │ AggregateFunction(groupBitmap, UInt8)        │
└─────┴──────────────────────────────────────────────┘

​
bitmapCardinality

Introduced in: v20.1.0 Returns the number of bits set (the cardinality) in the bitmap. Syntax 
bitmapCardinality(bitmap)
Arguments Returned value Returns the number of bits set in the bitmap UInt64 Examples Usage example
Query
SELECT bitmapCardinality(bitmapBuild([1, 3, 3, 5, 7, 7])) AS res
Response
┌─res─┐
│   4 │
└─────┘

​
bitmapContains

Introduced in: v20.1.0 Checks if the bitmap contains a specific element. Syntax 
bitmapContains(bitmap, value)
Arguments Returned value Returns 1 if the bitmap contains the specified value, otherwise 0 UInt8 Examples Usage example
Query
SELECT bitmapContains(bitmapBuild([1, 2, 3]), 2) AS res;
Response
┌─res─┐
│  1  │
└─────┘

​
bitmapHasAll

Introduced in: v20.1.0 Checks if the first bitmap contains all set bits of the second bitmap. Syntax 
bitmapHasAll(bitmap1, bitmap2)
Arguments Returned value Returns 1 if all set bits of the second bitmap are present in the first bitmap, otherwise 0 UInt8 Examples Usage example
Query
SELECT bitmapHasAll(bitmapBuild([1, 2, 3]), bitmapBuild([2, 3])) AS res;
Response
┌─res─┐
│  1  │
└─────┘

​
bitmapHasAny

Introduced in: v20.1.0 Checks if the first bitmap contains any set bits of the second bitmap. Syntax 
bitmapHasAny(bitmap1, bitmap2)
Arguments Returned value Returns 1 if any bits of the second bitmap are present in the first bitmap, otherwise 0 UInt8 Examples Usage example
Query
SELECT bitmapHasAny(bitmapBuild([1, 2, 3]), bitmapBuild([3, 4, 5])) AS res;
Response
┌─res─┐
│  1  │
└─────┘

​
bitmapMax

Introduced in: v20.1.0 Returns the position of the greatest bit set in a bitmap, or 0 if the bitmap is empty. Syntax 
bitmapMax(bitmap)
Arguments Returned value Returns the position of the greatest bit set in the bitmap, otherwise 0 UInt64 Examples Usage example
Query
SELECT bitmapMax(bitmapBuild([1, 2, 3, 4, 5])) AS res;
Response
┌─res─┐
│   5 │
└─────┘

​
bitmapMin

Introduced in: v20.1.0 Returns the position of the smallest bit set in a bitmap. If all bits are unset, or UINT32_MAX (UINT64_MAX if the bitmap contains more than 2^64 bits). Syntax 
bitmapMin(bitmap)
Arguments Returned value Returns the position of the smallest bit set in the bitmap, or UINT32_MAX/UINT64_MAX UInt64 Examples Usage example
Query
SELECT bitmapMin(bitmapBuild([3, 5, 2, 6])) AS res;
Response
┌─res─┐
│   2 │
└─────┘

​
bitmapOr

Introduced in: v20.1.0 Computes the logical disjunction (OR) of two bitmaps. Syntax 
bitmapOr(bitmap1, bitmap2)
Arguments Returned value Returns a bitmap containing set bits present in either input bitmap AggregateFunction(groupBitmap, T) Examples Usage example
Query
SELECT bitmapToArray(bitmapOr(bitmapBuild([1, 2, 3]), bitmapBuild([3, 4, 5]))) AS res;
Response
┌─res─────────────┐
│ [1, 2, 3, 4, 5] │
└─────────────────┘

​
bitmapOrCardinality

Introduced in: v20.1.0 Returns the cardinality of the logical disjunction (OR) of two bitmaps. Syntax 
bitmapOrCardinality(bitmap1, bitmap2)
Arguments Returned value Returns the number of set bits in the union of the two bitmaps UInt64 Examples Usage example
Query
SELECT bitmapOrCardinality(bitmapBuild([1,2,3]), bitmapBuild([3,4,5])) AS res;
Response
┌─res─┐
│   5 │
└─────┘

​
bitmapSubsetInRange

Introduced in: v20.1.0 Returns a subset of the bitmap, containing only the set bits in the specified range [start, end). Uses 1-based indexing. Syntax 
bitmapSubsetInRange(bitmap, start, end)
Arguments Returned value Returns a bitmap containing only the set bits in the specified range AggregateFunction(groupBitmap, T) Examples Usage example
Query
SELECT bitmapToArray(bitmapSubsetInRange(bitmapBuild([1, 2, 3, 4, 5]), 2, 5)) AS res;
Response
┌─res───────┐
│ [2, 3, 4] │
└───────────┘

​
bitmapSubsetLimit

Introduced in: v20.1.0 Returns a subset of a bitmap from position range_start with at most cardinality_limit set bits. Uses 1-based indexing. Syntax 
bitmapSubsetLimit(bitmap, range_start, cardinality_limit)
Arguments Returned value Returns a bitmap containing at most cardinality_limit set bits, starting from range_start AggregateFunction(groupBitmap, T) Examples Usage example
Query
SELECT bitmapToArray(bitmapSubsetLimit(bitmapBuild([1, 5, 3, 2, 8]), 3, 2)) AS res;
Response
┌─res────┐
│ [5, 3] │
└────────┘

​
bitmapToArray

Introduced in: v20.1.0 Converts a bitmap to an array of unsigned integers. It is the opposite of function bitmapBuild. Syntax 
bitmapToArray(bitmap)
Arguments Returned value Returns an array of unsigned integers contained in the bitmap Array(UInt*) Examples Usage example
Query
SELECT bitmapToArray(bitmapBuild([1, 2, 3, 4, 5])) AS res;
Response
┌─res─────────────┐
│ [1, 2, 3, 4, 5] │
└─────────────────┘

​
bitmapTransform

Introduced in: v20.1.0 Changes up to N bits in a bitmap by swapping specific bit values in from_array with corresponding ones in to_array. Syntax 
bitmapTransform(bitmap, from_array, to_array)
Arguments Returned value Returns a bitmap with elements transformed according to the given mapping AggregateFunction(groupBitmap, T) Examples Usage example
Query
SELECT bitmapToArray(bitmapTransform(bitmapBuild([1, 2, 3, 4, 5]), [2, 4], [20, 40])) AS res;
Response
┌─res───────────────┐
│ [1, 3, 5, 20, 40] │
└───────────────────┘

​
bitmapXor

Introduced in: v20.1.0 Computes the symmetric difference (XOR) of two bitmaps. Syntax 
bitmapXor(bitmap1, bitmap2)
Arguments Returned value Returns a bitmap containing set bits present in either input bitmap, but not in both AggregateFunction(groupBitmap, T) Examples Usage example
Query
SELECT bitmapToArray(bitmapXor(bitmapBuild([1, 2, 3]), bitmapBuild([3, 4, 5]))) AS res;
Response
┌─res──────────┐
│ [1, 2, 4, 5] │
└──────────────┘

​
bitmapXorCardinality

Introduced in: v20.1.0 Returns the cardinality of the XOR (symmetric difference) of two bitmaps. Syntax 
bitmapXorCardinality(bitmap1, bitmap2)
Arguments Returned value Returns the number of set bits in the symmetric difference of the two bitmaps UInt64 Examples Usage example
Query
SELECT bitmapXorCardinality(bitmapBuild([1,2,3]), bitmapBuild([3,4,5])) AS res;
Response
┌─res─┐
│   4 │
└─────┘

​
subBitmap

Introduced in: v21.9.0 Returns a subset of the bitmap, starting from position offset. The maximum cardinality of the returned bitmap is cardinality_limit. Syntax 
subBitmap(bitmap, offset, cardinality_limit)
Arguments
  • bitmap — Bitmap object. AggregateFunction(groupBitmap, T). - offset — Number of set bits to skip from the beginning (zero-based). UInt32 - cardinality_limit — Maximum number of set bits to include in the subset. UInt32
Returned value Returns a bitmap containing at most limit set bits, starting after skipping offset set bits in ascending order AggregateFunction(groupBitmap, T) Examples Usage example
Query
SELECT bitmapToArray(subBitmap(bitmapBuild([1, 2, 3, 4, 5]), 2, 2)) AS res;
Response
┌─res────┐
│ [3, 4] │
└────────┘