Перейти к основному содержимому
Перейти к основному содержимому

tuple-map-functions

description: 'Документация по функциям Map для Tuple' sidebar_label: 'Map' sidebar_position: 120 slug: /sql-reference/functions/tuple-map-functions title: 'Функции Map'


## map \{#map}

Создает значение типа [Map(key, value)](../data-types/map.md) из пар ключ-значение.

**Синтаксис**

```sql
map(key1, value1[, key2, value2, ...])

Аргументы

  • key_n — Ключи записей карты. Любой тип, поддерживаемый в качестве типа ключа для Map.
  • value_n — Значения записей карты. Любой тип, поддерживаемый в качестве типа значения для Map.

Возвращаемое значение

Примеры

Запрос:

SELECT map('key1', number, 'key2', number * 2) FROM numbers(3);

Результат:

┌─map('key1', number, 'key2', multiply(number, 2))─┐
│ {'key1':0,'key2':0}                              │
│ {'key1':1,'key2':2}                              │
│ {'key1':2,'key2':4}                              │
└──────────────────────────────────────────────────┘

mapFromArrays

Создает карту из массива или карты ключей и массива или карты значений.

Функция является удобной альтернативой синтаксису CAST([...], 'Map(key_type, value_type)'). Например, вместо записи

  • CAST((['aa', 'bb'], [4, 5]), 'Map(String, UInt32)'), или
  • CAST([('aa',4), ('bb',5)], 'Map(String, UInt32)')

вы можете записать mapFromArrays(['aa', 'bb'], [4, 5]).

Синтаксис

mapFromArrays(keys, values)

Псевдоним: MAP_FROM_ARRAYS(keys, values)

Аргументы

  • keys — Массив или карта ключей для создания карты из Array или Map. Если keys является массивом, принимаем Array(Nullable(T)) или Array(LowCardinality(Nullable(T))) в качестве его типа, при условии, что он не содержит значений NULL.
  • values - Массив или карта значений для создания карты из Array или Map.

Возвращаемое значение

  • Карта с ключами и значениями, сконструированными из массива ключей и массива/карты значений.

Пример

Запрос:

select mapFromArrays(['a', 'b', 'c'], [1, 2, 3])

Результат:

┌─mapFromArrays(['a', 'b', 'c'], [1, 2, 3])─┐
│ {'a':1,'b':2,'c':3}                       │
└───────────────────────────────────────────┘

mapFromArrays также принимает аргументы типа Map. Они преобразуются в массив кортежей во время выполнения.

SELECT mapFromArrays([1, 2, 3], map('a', 1, 'b', 2, 'c', 3))

Результат:

┌─mapFromArrays([1, 2, 3], map('a', 1, 'b', 2, 'c', 3))─┐
│ {1:('a',1),2:('b',2),3:('c',3)}                       │
└───────────────────────────────────────────────────────┘
SELECT mapFromArrays(map('a', 1, 'b', 2, 'c', 3), [1, 2, 3])

Результат:

┌─mapFromArrays(map('a', 1, 'b', 2, 'c', 3), [1, 2, 3])─┐
│ {('a',1):1,('b',2):2,('c',3):3}                       │
└───────────────────────────────────────────────────────┘

extractKeyValuePairs

Преобразует строку пар ключ-значение в Map(String, String). Парсинг нечувствителен к шуму (например, файлы логов). Пар ключ-значение во входной строке состоит из ключа, за которым следует разделитель ключ-значение и значение. Парные ключи разделяются разделителем пар. Ключи и значения могут быть в кавычках.

Синтаксис

extractKeyValuePairs(data[, key_value_delimiter[, pair_delimiter[, quoting_character]]])

Псевдонимы:

  • str_to_map
  • mapFromString

Аргументы

  • data - Строка для извлечения пар ключ-значение. String или FixedString.
  • key_value_delimiter - Один символ, разделяющий ключи и значения. По умолчанию :. String или FixedString.
  • pair_delimiters - Набор символов, разделяющих пары. По умолчанию , , и ;. String или FixedString.
  • quoting_character - Один символ, используемый в качестве символа кавычек. По умолчанию ". String или FixedString.

Возвращаемые значения

Примеры

Запрос

SELECT extractKeyValuePairs('name:neymar, age:31 team:psg,nationality:brazil') as kv

Результат:

┌─kv──────────────────────────────────────────────────────────────────────┐
│ {'name':'neymar','age':'31','team':'psg','nationality':'brazil'}        │
└─────────────────────────────────────────────────────────────────────────┘

С одинарной кавычкой ' в качестве символа кавычек:

SELECT extractKeyValuePairs('name:\'neymar\';\'age\':31;team:psg;nationality:brazil,last_key:last_value', ':', ';,', '\'') as kv

Результат:

┌─kv───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ {'name':'neymar','age':'31','team':'psg','nationality':'brazil','last_key':'last_value'}                                 │
└──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘

Эскапированные последовательности без поддержки эскейпирования:

SELECT extractKeyValuePairs('age:a\\x0A\\n\\0') AS kv

Результат:

┌─kv─────────────────────┐
│ {'age':'a\\x0A\\n\\0'} │
└────────────────────────┘

Чтобы восстановить строку карты пар ключ-значение, сериализованную с помощью toString:

SELECT
    map('John', '33', 'Paula', '31') AS m,
    toString(m) as map_serialized,
    extractKeyValuePairs(map_serialized, ':', ',', '\'') AS map_restored
FORMAT Vertical;

Результат:

Row 1:
──────
m:              {'John':'33','Paula':'31'}
map_serialized: {'John':'33','Paula':'31'}
map_restored:   {'John':'33','Paula':'31'}

extractKeyValuePairsWithEscaping

То же самое, что и extractKeyValuePairs, но поддерживает эскейпирование.

Поддерживаемые escape-последовательности: \x, \N, \a, \b, \e, \f, \n, \r, \t, \v и \0. Нестандартные escape-последовательности возвращаются такими, какие они есть (включая обратный слеш), если они не являются одним из следующих: \\, ', ", backtick, /, = или условные управляющие символы ASCII (c <= 31).

Эта функция удовлетворяет использование случаев, когда предварительное и последующее экранирование неприменимо. Например, рассмотрим следующую входную строку: a: "aaaa\"bbb". Ожидаемый вывод: a: aaaa\"bbbb.

  • Предварительное экранирование: Экранирование приведет к выводу: a: "aaaa"bbb", а затем extractKeyValuePairs выдаст: a: aaaa
  • Последующее экранирование: extractKeyValuePairs выдаст a: aaaa\, а последующее экранирование оставит это как есть.

Ведущие escape-последовательности будут пропущены в ключах и будут считаться недопустимыми для значений.

Примеры

Escape-последовательности с поддержкой escape-последовательностей:

SELECT extractKeyValuePairsWithEscaping('age:a\\x0A\\n\\0') AS kv

Результат:

┌─kv────────────────┐
│ {'age':'a\n\n\0'} │
└───────────────────┘

mapAdd

Собирает все ключи и суммирует соответствующие значения.

Синтаксис

mapAdd(arg1, arg2 [, ...])

Аргументы

Аргументы являются map или кортежами из двух массивов, где элементы первого массива представляют ключи, а второй массив содержит значения для каждого ключа. Все массивы ключей должны быть одного типа, а все массивы значений должны содержать элементы, которые преобразуются в один тип (Int64, UInt64 или Float64). Общий преобразуемый тип используется как тип для результирующего массива.

Возвращаемое значение

  • В зависимости от аргументов возвращает один map или tuple, где первый массив содержит отсортированные ключи, а второй массив содержит значения.

Пример

Запрос с типом Map:

SELECT mapAdd(map(1,1), map(1,1));

Результат:

┌─mapAdd(map(1, 1), map(1, 1))─┐
│ {1:2}                        │
└──────────────────────────────┘

Запрос с кортежем:

SELECT mapAdd(([toUInt8(1), 2], [1, 1]), ([toUInt8(1), 2], [1, 1])) as res, toTypeName(res) as type;

Результат:

┌─res───────────┬─type───────────────────────────────┐
│ ([1,2],[2,2]) │ Tuple(Array(UInt8), Array(UInt64)) │
└───────────────┴────────────────────────────────────┘

mapSubtract

Собирает все ключи и вычитает соответствующие значения.

Синтаксис

mapSubtract(Tuple(Array, Array), Tuple(Array, Array) [, ...])

Аргументы

Аргументы являются map или кортежами из двух массивов, где элементы первого массива представляют ключи, а второй массив содержит значения для каждого ключа. Все массивы ключей должны быть одного типа, а все массивы значений должны содержать элементы, которые преобразуются в один тип (Int64, UInt64 или Float64). Общий преобразуемый тип используется как тип для результирующего массива.

Возвращаемое значение

  • В зависимости от аргументов возвращает один map или tuple, где первый массив содержит отсортированные ключи, а второй массив содержит значения.

Пример

Запрос с типом Map:

SELECT mapSubtract(map(1,1), map(1,1));

Результат:

┌─mapSubtract(map(1, 1), map(1, 1))─┐
│ {1:0}                             │
└───────────────────────────────────┘

Запрос с кортежем map:

SELECT mapSubtract(([toUInt8(1), 2], [toInt32(1), 1]), ([toUInt8(1), 2], [toInt32(2), 1])) as res, toTypeName(res) as type;

Результат:

┌─res────────────┬─type──────────────────────────────┐
│ ([1,2],[-1,0]) │ Tuple(Array(UInt8), Array(Int64)) │
└────────────────┴───────────────────────────────────┘

mapPopulateSeries

Заполняет отсутствующие пары ключ-значение в карте с целочисленными ключами. Чтобы поддержать расширение ключей за пределы наибольшего значения, можно указать максимальный ключ. Более конкретно, функция возвращает карту, в которой ключи образуют последовательность от наименьшего до наибольшего ключа (или аргумента max, если он указан) с шагом 1, и соответствующие значения. Если для ключа не указано значение, используется значение по умолчанию. В случае повторения ключей только первое значение (по порядку появления) связывается с ключом.

Синтаксис

mapPopulateSeries(map[, max])
mapPopulateSeries(keys, values[, max])

Для массивных аргументов количество элементов в keys и values должно быть одинаковым для каждой строки.

Аргументы

Аргументы являются Map или двумя Arrays, где первый и второй массив содержат ключи и значения для каждого ключа.

Сопоставленные массивы:

  • map — Карта с целочисленными ключами. Map.

или

Возвращаемое значение

  • В зависимости от аргументов возвращает Map или Tuple из двух Arrays: ключи в отсортированном порядке и соответствующие значения.

Пример

Запрос с типом Map:

SELECT mapPopulateSeries(map(1, 10, 5, 20), 6);

Результат:

┌─mapPopulateSeries(map(1, 10, 5, 20), 6)─┐
│ {1:10,2:0,3:0,4:0,5:20,6:0}             │
└─────────────────────────────────────────┘

Запрос с сопоставленными массивами:

SELECT mapPopulateSeries([1,2,4], [11,22,44], 5) AS res, toTypeName(res) AS type;

Результат:

┌─res──────────────────────────┬─type──────────────────────────────┐
│ ([1,2,3,4,5],[11,22,0,44,0]) │ Tuple(Array(UInt8), Array(UInt8)) │
└──────────────────────────────┴───────────────────────────────────┘

mapKeys

Возвращает ключи данной карты.

Эта функция может быть оптимизирована путем включения настройки optimize_functions_to_subcolumns. С включенной настройкой функция читает только подколонку keys вместо всей карты. Запрос SELECT mapKeys(m) FROM table преобразуется в SELECT m.keys FROM table.

Синтаксис

mapKeys(map)

Аргументы

  • map — Карта. Map.

Возвращаемое значение

  • Массив, содержащий все ключи из map. Array.

Пример

Запрос:

CREATE TABLE tab (a Map(String, String)) ENGINE = Memory;

INSERT INTO tab VALUES ({'name':'eleven','age':'11'}), ({'number':'twelve','position':'6.0'});

SELECT mapKeys(a) FROM tab;

Результат:

┌─mapKeys(a)────────────┐
│ ['name','age']        │
│ ['number','position'] │
└───────────────────────┘

mapContains

Возвращает, если данный ключ содержится в данной карте.

Синтаксис

mapContains(map, key)

Псевдоним: mapContainsKey(map, key)

Аргументы

  • map — Карта. Map.
  • key — Ключ. Тип должен соответствовать типу ключа map.

Возвращаемое значение

  • 1, если map содержит key, 0, если нет. UInt8.

Пример

Запрос:

CREATE TABLE tab (a Map(String, String)) ENGINE = Memory;

INSERT INTO tab VALUES ({'name':'eleven','age':'11'}), ({'number':'twelve','position':'6.0'});

SELECT mapContains(a, 'name') FROM tab;

Результат:

┌─mapContains(a, 'name')─┐
│                      1 │
│                      0 │
└────────────────────────┘

mapContainsKeyLike

Синтаксис

mapContainsKeyLike(map, pattern)

Аргументы

  • map — Карта. Map.
  • pattern - Шаблон строки для сопоставления.

Возвращаемое значение

  • 1, если map содержит key, соответствующий указанному шаблону, 0, если нет.

Пример

Запрос:

CREATE TABLE tab (a Map(String, String)) ENGINE = Memory;

INSERT INTO tab VALUES ({'abc':'abc','def':'def'}), ({'hij':'hij','klm':'klm'});

SELECT mapContainsKeyLike(a, 'a%') FROM tab;

Результат:

┌─mapContainsKeyLike(a, 'a%')─┐
│                           1 │
│                           0 │
└─────────────────────────────┘

mapExtractKeyLike

Данная функция принимает карту с ключами-строками и шаблон LIKE и возвращает карту с элементами, ключи которых соответствуют шаблону.

Синтаксис

mapExtractKeyLike(map, pattern)

Аргументы

  • map — Карта. Map.
  • pattern - Шаблон строки для сопоставления.

Возвращаемое значение

  • Карта, содержащая элементы, у которых ключ соответствует указанному шаблону. Если ни один элемент не соответствует шаблону, возвращается пустая карта.

Пример

Запрос:

CREATE TABLE tab (a Map(String, String)) ENGINE = Memory;

INSERT INTO tab VALUES ({'abc':'abc','def':'def'}), ({'hij':'hij','klm':'klm'});

SELECT mapExtractKeyLike(a, 'a%') FROM tab;

Результат:

┌─mapExtractKeyLike(a, 'a%')─┐
│ {'abc':'abc'}              │
│ {}                         │
└────────────────────────────┘

mapValues

Возвращает значения данной карты.

Эта функция может быть оптимизирована путем включения настройки optimize_functions_to_subcolumns. С включенной настройкой функция читает только подколонку values вместо всей карты. Запрос SELECT mapValues(m) FROM table преобразуется в SELECT m.values FROM table.

Синтаксис

mapValues(map)

Аргументы

  • map — Карта. Map.

Возвращаемое значение

  • Массив, содержащий все значения из map. Array.

Пример

Запрос:

CREATE TABLE tab (a Map(String, String)) ENGINE = Memory;

INSERT INTO tab VALUES ({'name':'eleven','age':'11'}), ({'number':'twelve','position':'6.0'});

SELECT mapValues(a) FROM tab;

Результат:

┌─mapValues(a)─────┐
│ ['eleven','11']  │
│ ['twelve','6.0'] │
└──────────────────┘

mapContainsValue

Возвращает, если данное значение содержится в данной карте.

Синтаксис

mapContainsValue(map, value)

Псевдоним: mapContainsValue(map, value)

Аргументы

  • map — Карта. Map.
  • value — Значение. Тип должен соответствовать типу значения map.

Возвращаемое значение

  • 1, если map содержит value, 0, если нет. UInt8.

Пример

Запрос:

CREATE TABLE tab (a Map(String, String)) ENGINE = Memory;

INSERT INTO tab VALUES ({'name':'eleven','age':'11'}), ({'number':'twelve','position':'6.0'});

SELECT mapContainsValue(a, '11') FROM tab;

Результат:

┌─mapContainsValue(a, '11')─┐
│                         1 │
│                         0 │
└───────────────────────────┘

mapContainsValueLike

Синтаксис

mapContainsValueLike(map, pattern)

Аргументы

  • map — Карта. Map.
  • pattern - Шаблон строки для сопоставления.

Возвращаемое значение

  • 1, если map содержит value, соответствующий указанному шаблону, 0, если нет.

Пример

Запрос:

CREATE TABLE tab (a Map(String, String)) ENGINE = Memory;

INSERT INTO tab VALUES ({'abc':'abc','def':'def'}), ({'hij':'hij','klm':'klm'});

SELECT mapContainsValueLike(a, 'a%') FROM tab;

Результат:

┌─mapContainsV⋯ke(a, 'a%')─┐
│                        1 │
│                        0 │
└──────────────────────────┘

mapExtractValueLike

Данная функция принимает карту с значениями-строками и шаблон LIKE и возвращает карту с элементами, у которых значение соответствует шаблону.

Синтаксис

mapExtractValueLike(map, pattern)

Аргументы

  • map — Карта. Map.
  • pattern - Шаблон строки для сопоставления.

Возвращаемое значение

  • Карта, содержащая элементы, у которых значение соответствует указанному шаблону. Если ни один элемент не соответствует шаблону, возвращается пустая карта.

Пример

Запрос:

CREATE TABLE tab (a Map(String, String)) ENGINE = Memory;

INSERT INTO tab VALUES ({'abc':'abc','def':'def'}), ({'hij':'hij','klm':'klm'});

SELECT mapExtractValueLike(a, 'a%') FROM tab;

Результат:

┌─mapExtractValueLike(a, 'a%')─┐
│ {'abc':'abc'}                │
│ {}                           │
└──────────────────────────────┘

mapApply

Применяет функцию к каждому элементу карты.

Синтаксис

mapApply(func, map)

Аргументы

Возвращаемое значение

  • Возвращает карту, полученную из оригинальной карты путем применения func(map1[i], ..., mapN[i]) для каждого элемента.

Пример

Запрос:

SELECT mapApply((k, v) -> (k, v * 10), _map) AS r
FROM
(
    SELECT map('key1', number, 'key2', number * 2) AS _map
    FROM numbers(3)
)

Результат:

┌─r─────────────────────┐
│ {'key1':0,'key2':0}   │
│ {'key1':10,'key2':20} │
│ {'key1':20,'key2':40} │
└───────────────────────┘

mapFilter

Фильтрует карту, применяя функцию к каждому элементу карты.

Синтаксис

mapFilter(func, map)

Аргументы

Возвращаемое значение

  • Возвращает карту, содержащую только элементы в map, для которых func(map1[i], ..., mapN[i]) возвращает что-то, кроме 0.

Пример

Запрос:

SELECT mapFilter((k, v) -> ((v % 2) = 0), _map) AS r
FROM
(
    SELECT map('key1', number, 'key2', number * 2) AS _map
    FROM numbers(3)
)

Результат:

┌─r───────────────────┐
│ {'key1':0,'key2':0} │
│ {'key2':2}          │
│ {'key1':2,'key2':4} │
└─────────────────────┘

mapUpdate

Синтаксис

mapUpdate(map1, map2)

Аргументы

Возвращаемое значение

  • Возвращает map1 с обновленными значениями для соответствующих ключей в map2.

Пример

Запрос:

SELECT mapUpdate(map('key1', 0, 'key3', 0), map('key1', 10, 'key2', 10)) AS map;

Результат:

┌─map────────────────────────────┐
│ {'key3':0,'key1':10,'key2':10} │
└────────────────────────────────┘

mapConcat

Конкатенирует несколько карт на основе равенства их ключей. Если элементы с одинаковым ключом существуют в более чем одной входной карте, все элементы добавляются в результирующую карту, но только первый из них доступен через оператор [].

Синтаксис

mapConcat(maps)

Аргументы

  • maps – Произвольное количество Maps.

Возвращаемое значение

  • Возвращает карту с конкатенированными картами, переданными в аргументах.

Примеры

Запрос:

SELECT mapConcat(map('key1', 1, 'key3', 3), map('key2', 2)) AS map;

Результат:

┌─map──────────────────────────┐
│ {'key1':1,'key3':3,'key2':2} │
└──────────────────────────────┘

Запрос:

SELECT mapConcat(map('key1', 1, 'key2', 2), map('key1', 3)) AS map, map['key1'];

Результат:

┌─map──────────────────────────┬─elem─┐
│ {'key1':1,'key2':2,'key1':3} │    1 │
└──────────────────────────────┴──────┘

mapExists([func,], map)

Возвращает 1, если хотя бы одна пара ключ-значение в map существует, для которой func(key, value) возвращает что-то, кроме 0. В противном случае возвращает 0.

примечание

mapExists является функцией высшего порядка. Вы можете передать лямбда-функцию в качестве первого аргумента.

Пример

Запрос:

SELECT mapExists((k, v) -> (v = 1), map('k1', 1, 'k2', 2)) AS res

Результат:

┌─res─┐
│   1 │
└─────┘

mapAll([func,] map)

Возвращает 1, если func(key, value) возвращает что-то, кроме 0 для всех пар ключ-значение в map. В противном случае возвращает 0.

примечание

Обратите внимание, что mapAll является функцией высшего порядка. Вы можете передать лямбда-функцию в качестве первого аргумента.

Пример

Запрос:

SELECT mapAll((k, v) -> (v = 1), map('k1', 1, 'k2', 2)) AS res

Результат:

┌─res─┐
│   0 │
└─────┘

mapSort([func,], map)

Сортирует элементы карты в порядке возрастания. Если функция func указана, порядок сортировки определяется результатом функции func, применяемой к ключам и значениям карты.

Примеры

SELECT mapSort(map('key2', 2, 'key3', 1, 'key1', 3)) AS map;
┌─map──────────────────────────┐
│ {'key1':3,'key2':2,'key3':1} │
└──────────────────────────────┘
SELECT mapSort((k, v) -> v, map('key2', 2, 'key3', 1, 'key1', 3)) AS map;
┌─map──────────────────────────┐
│ {'key3':1,'key2':2,'key1':3} │
└──────────────────────────────┘

Для получения дополнительных сведений смотрите справочник по функции arraySort.

mapPartialSort

Сортирует элементы карты в порядке возрастания с дополнительным аргументом limit, позволяющим частичную сортировку. Если функция func указана, порядок сортировки определяется результатом функции func, применяемой к ключам и значениям карты.

Синтаксис

mapPartialSort([func,] limit, map)

Аргументы

  • func – Необязательная функция, применяемая к ключам и значениям карты. Лямбда-функция.
  • limit – Элементы в диапазоне [1..limit] сортируются. (U)Int.
  • map – Карта для сортировки. Map.

Возвращаемое значение

  • Частично отсортированная карта. Map.

Пример

SELECT mapPartialSort((k, v) -> v, 2, map('k1', 3, 'k2', 1, 'k3', 2));
┌─mapPartialSort(lambda(tuple(k, v), v), 2, map('k1', 3, 'k2', 1, 'k3', 2))─┐
│ {'k2':1,'k3':2,'k1':3}                                                    │
└───────────────────────────────────────────────────────────────────────────┘

mapReverseSort([func,], map)

Сортирует элементы карты в порядке убывания. Если функция func указана, порядок сортировки определяется результатом функции func, применяемой к ключам и значениям карты.

Примеры

SELECT mapReverseSort(map('key2', 2, 'key3', 1, 'key1', 3)) AS map;
┌─map──────────────────────────┐
│ {'key3':1,'key2':2,'key1':3} │
└──────────────────────────────┘
SELECT mapReverseSort((k, v) -> v, map('key2', 2, 'key3', 1, 'key1', 3)) AS map;
┌─map──────────────────────────┐
│ {'key1':3,'key2':2,'key3':1} │
└──────────────────────────────┘

Для получения дополнительных сведений смотрите функцию arrayReverseSort.

mapPartialReverseSort

Сортирует элементы карты в порядке убывания с дополнительным аргументом limit, позволяющим частичную сортировку. Если функция func указана, порядок сортировки определяется результатом функции func, применяемой к ключам и значениям карты.

Синтаксис

mapPartialReverseSort([func,] limit, map)

Аргументы

  • func – Необязательная функция, применяемая к ключам и значениям карты. Лямбда-функция.
  • limit – Элементы в диапазоне [1..limit] сортируются. (U)Int.
  • map – Карта для сортировки. Map.

Возвращаемое значение

  • Частично отсортированная карта. Map.

Пример

SELECT mapPartialReverseSort((k, v) -> v, 2, map('k1', 3, 'k2', 1, 'k3', 2));
┌─mapPartialReverseSort(lambda(tuple(k, v), v), 2, map('k1', 3, 'k2', 1, 'k3', 2))─┐
│ {'k1':3,'k3':2,'k2':1}                                                           │
└──────────────────────────────────────────────────────────────────────────────────┘