ClickHouse/docs/ru/sql-reference/functions/bitmap-functions.md

401 lines
9.5 KiB
Markdown
Raw Normal View History

---
toc_priority: 49
toc_title: "\u0424\u0443\u043d\u043a\u0446\u0438\u0438\u0020\u0434\u043b\u044f\u0020\u0431\u0438\u0442\u043c\u0430\u043f\u043e\u0432"
---
# Функции для битовых масок {#bitmap-functions}
## bitmapBuild {#bitmap_functions-bitmapbuild}
Создаёт битовый массив из массива целочисленных значений.
``` sql
bitmapBuild(array)
```
**Параметры**
- `array` массив типа `UInt*`.
**Пример**
``` sql
2019-06-14 10:29:16 +00:00
SELECT bitmapBuild([1, 2, 3, 4, 5]) AS res, toTypeName(res)
```
``` text
2019-06-14 10:29:16 +00:00
┌─res─┬─toTypeName(bitmapBuild([1, 2, 3, 4, 5]))─────┐
 │ AggregateFunction(groupBitmap, UInt8) │
└─────┴──────────────────────────────────────────────┘
```
## bitmapToArray {#bitmaptoarray}
Преобразует битовый массив в массив целочисленных значений.
``` sql
bitmapToArray(bitmap)
```
**Параметры**
- `bitmap` битовый массив.
**Пример**
``` sql
SELECT bitmapToArray(bitmapBuild([1, 2, 3, 4, 5])) AS res
```
``` text
┌─res─────────┐
│ [1,2,3,4,5] │
└─────────────┘
```
## bitmapSubsetLimit {#bitmapsubsetlimit}
2019-11-27 09:09:44 +00:00
Создает подмножество битмапа с n элементами, расположенными между `range_start` и `cardinality_limit`.
**Синтаксис**
``` sql
bitmapSubsetLimit(bitmap, range_start, cardinality_limit)
```
**Параметры**
- `bitmap` Битмап. [Bitmap object](#bitmap_functions-bitmapbuild).
2020-09-15 09:24:03 +00:00
- `range_start` Начальная точка подмножества. [UInt32](../../sql-reference/functions/bitmap-functions.md#bitmap-functions).
- `cardinality_limit` Верхний предел подмножества. [UInt32](../../sql-reference/functions/bitmap-functions.md#bitmap-functions).
**Возвращаемое значение**
2019-11-27 09:09:44 +00:00
Подмножество битмапа.
Тип: `Bitmap object`.
**Пример**
Запрос:
``` sql
2019-11-27 09:09:44 +00:00
SELECT bitmapToArray(bitmapSubsetLimit(bitmapBuild([0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,100,200,500]), toUInt32(30), toUInt32(200))) AS res
```
Ответ:
``` text
2019-11-27 09:09:44 +00:00
┌─res───────────────────────┐
│ [30,31,32,33,100,200,500] │
└───────────────────────────┘
```
## bitmapContains {#bitmap_functions-bitmapcontains}
Проверяет вхождение элемента в битовый массив.
``` sql
bitmapContains(haystack, needle)
```
**Параметры**
- `haystack` [объект Bitmap](#bitmap_functions-bitmapbuild), в котором функция ищет значение.
2020-09-15 11:38:22 +00:00
- `needle` значение, которое функция ищет. Тип — [UInt32](../../sql-reference/data-types/int-uint.md).
**Возвращаемые значения**
- 0 — если в `haystack` нет `needle`.
- 1 — если в `haystack` есть `needle`.
Тип — `UInt8`.
**Пример**
``` sql
SELECT bitmapContains(bitmapBuild([1,5,7,9]), toUInt32(9)) AS res
```
``` text
┌─res─┐
│ 1 │
└─────┘
```
## bitmapHasAny {#bitmaphasany}
Проверяет, имеют ли два битовых массива хотя бы один общий элемент.
``` sql
2019-06-14 10:29:16 +00:00
bitmapHasAny(bitmap1, bitmap2)
```
Если вы уверены, что `bitmap2` содержит строго один элемент, используйте функцию [bitmapContains](#bitmap_functions-bitmapcontains). Она работает эффективнее.
**Параметры**
- `bitmap*` массив любого типа с набором элементов.
2019-06-14 10:29:16 +00:00
**Возвращаемые значения**
- `1`, если `bitmap1` и `bitmap2` имеют хотя бы один одинаковый элемент.
- `0`, в противном случае.
**Пример**
``` sql
SELECT bitmapHasAny(bitmapBuild([1,2,3]),bitmapBuild([3,4,5])) AS res
```
``` text
┌─res─┐
│ 1 │
└─────┘
```
## bitmapHasAll {#bitmaphasall}
Аналогично функции `hasAll(array, array)` возвращает 1 если первый битовый массив содержит все элементы второго, 0 в противном случае.
Если второй аргумент является пустым битовым массивом, то возвращает 1.
``` sql
bitmapHasAll(bitmap,bitmap)
```
**Параметры**
- `bitmap` битовый массив.
**Пример**
``` sql
SELECT bitmapHasAll(bitmapBuild([1,2,3]),bitmapBuild([3,4,5])) AS res
```
``` text
┌─res─┐
│ 0 │
└─────┘
```
## bitmapAnd {#bitmapand}
Логическое И для двух битовых массивов. Результат — новый битовый массив.
``` sql
bitmapAnd(bitmap,bitmap)
```
**Параметры**
- `bitmap` битовый массив.
**Пример**
``` sql
SELECT bitmapToArray(bitmapAnd(bitmapBuild([1,2,3]),bitmapBuild([3,4,5]))) AS res
```
``` text
┌─res─┐
│ [3] │
└─────┘
```
## bitmapOr {#bitmapor}
Логическое ИЛИ для двух битовых массивов. Результат — новый битовый массив.
``` sql
bitmapOr(bitmap,bitmap)
```
**Параметры**
- `bitmap` битовый массив.
**Пример**
``` sql
SELECT bitmapToArray(bitmapOr(bitmapBuild([1,2,3]),bitmapBuild([3,4,5]))) AS res
```
``` text
┌─res─────────┐
│ [1,2,3,4,5] │
└─────────────┘
```
## bitmapXor {#bitmapxor}
Логическое исключающее ИЛИ для двух битовых массивов. Результат — новый битовый массив.
``` sql
bitmapXor(bitmap,bitmap)
```
**Параметры**
- `bitmap` битовый массив.
**Пример**
``` sql
SELECT bitmapToArray(bitmapXor(bitmapBuild([1,2,3]),bitmapBuild([3,4,5]))) AS res
```
``` text
┌─res───────┐
│ [1,2,4,5] │
└───────────┘
```
## bitmapAndnot {#bitmapandnot}
Логическое отрицание И для двух битовых массивов. Результат — новый битовый массив.
``` sql
bitmapAndnot(bitmap,bitmap)
```
**Параметры**
- `bitmap` битовый массив.
**Пример**
``` sql
SELECT bitmapToArray(bitmapAndnot(bitmapBuild([1,2,3]),bitmapBuild([3,4,5]))) AS res
```
``` text
┌─res───┐
│ [1,2] │
└───────┘
```
## bitmapCardinality {#bitmapcardinality}
Возвращает кардинальность битового массива в виде значения типа `UInt64`.
``` sql
bitmapCardinality(bitmap)
```
**Параметры**
- `bitmap` битовый массив.
**Пример**
``` sql
SELECT bitmapCardinality(bitmapBuild([1, 2, 3, 4, 5])) AS res
```
``` text
┌─res─┐
│ 5 │
└─────┘
```
## bitmapAndCardinality {#bitmapandcardinality}
Выполняет логическое И и возвращает кардинальность (`UInt64`) результирующего битового массива.
``` sql
bitmapAndCardinality(bitmap,bitmap)
```
**Параметры**
- `bitmap` битовый массив.
**Пример**
``` sql
SELECT bitmapAndCardinality(bitmapBuild([1,2,3]),bitmapBuild([3,4,5])) AS res;
```
``` text
┌─res─┐
│ 1 │
└─────┘
```
## bitmapOrCardinality {#bitmaporcardinality}
Выполняет логическое ИЛИ и возвращает кардинальность (`UInt64`) результирующего битового массива.
``` sql
bitmapOrCardinality(bitmap,bitmap)
```
**Параметры**
- `bitmap` битовый массив.
**Пример**
``` sql
SELECT bitmapOrCardinality(bitmapBuild([1,2,3]),bitmapBuild([3,4,5])) AS res;
```
``` text
┌─res─┐
│ 5 │
└─────┘
```
## bitmapXorCardinality {#bitmapxorcardinality}
Выполняет логическое исключающее ИЛИ и возвращает кардинальность (`UInt64`) результирующего битового массива.
``` sql
bitmapXorCardinality(bitmap,bitmap)
```
**Параметры**
- `bitmap` битовый массив.
**Пример**
``` sql
SELECT bitmapXorCardinality(bitmapBuild([1,2,3]),bitmapBuild([3,4,5])) AS res;
```
``` text
┌─res─┐
│ 4 │
└─────┘
```
## bitmapAndnotCardinality {#bitmapandnotcardinality}
Выполняет логическое отрицание И и возвращает кардинальность (`UInt64`) результирующего битового массива.
``` sql
bitmapAndnotCardinality(bitmap,bitmap)
```
**Параметры**
- `bitmap` битовый массив.
**Пример**
``` sql
SELECT bitmapAndnotCardinality(bitmapBuild([1,2,3]),bitmapBuild([3,4,5])) AS res;
```
``` text
┌─res─┐
│ 2 │
└─────┘
```
2020-01-30 10:34:55 +00:00
[Оригинальная статья](https://clickhouse.tech/docs/ru/query_language/functions/bitmap_functions/) <!--hide-->