# Map (/docs/reference/sql/functions/map)



This page describes the RawTree engine binary used to generate this reference. It does not define Query API support. Descriptions retain upstream ClickHouse terminology. See [SQL interface scope](/docs/reference/clickhouse-compatibility#service-interfaces).

extractKeyValuePairs [#extractkeyvaluepairs]

Extracts key-value pairs from any string. The string does not need to be 100% structured in a key value pair format;

It can contain noise (e.g. log files). The key-value pair format to be interpreted should be specified via function arguments.

A key-value pair consists of a key followed by a `key_value_delimiter` and a value. Quoted keys and values are also supported. Key value pairs must be separated by pair delimiters.

**Syntax**

```sql
extractKeyValuePairs(data, [key_value_delimiter], [pair_delimiter], [quoting_character], [unexpected_quoting_character_strategy])
```

**Arguments**

* `data` - String to extract key-value pairs from. [String](/reference/data-types/string) or [FixedString](/reference/data-types/fixedstring).
* `key_value_delimiter` - Character to be used as delimiter between the key and the value. Defaults to `:`. [String](/reference/data-types/string) or [FixedString](/reference/data-types/fixedstring).
* `pair_delimiters` - Set of character to be used as delimiters between pairs. Defaults to `\space`, `,` and `;`. [String](/reference/data-types/string) or [FixedString](/reference/data-types/fixedstring).
* `quoting_character` - Character to be used as quoting character. Defaults to `"`. [String](/reference/data-types/string) or [FixedString](/reference/data-types/fixedstring).
* `unexpected_quoting_character_strategy` - Strategy to handle quoting characters in unexpected places during `read_key` and `read_value` phase. Possible values: `invalid`, `accept` and `promote`. Invalid will discard key/value and transition back to `WAITING_KEY` state. Accept will treat it as a normal character. Promote will transition to `READ_QUOTED_{KEY/VALUE}` state and start from next character. The default value is `PROMOTE`

**Returned values**

* The extracted key-value pairs in a Map(String, String).

**Examples**

Query:

**Simple case**

```sql
arthur :) select extractKeyValuePairs('name:neymar, age:31 team:psg,nationality:brazil') as kv

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

Query id: f9e0ca6f-3178-4ee2-aa2c-a5517abb9cee

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

**Single quote as quoting character**

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

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

Query id: 0e22bf6b-9844-414a-99dc-32bf647abd5e

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

unexpected\_quoting\_character\_strategy examples:

unexpected\_quoting\_character\_strategy=invalid

```sql
SELECT extractKeyValuePairs('name"abc:5', ':', ' ,;', '\"', 'INVALID') as kv;
```

```text
┌─kv────────────────┐
│ {'abc':'5'}       │
└───────────────────┘
```

```sql
SELECT extractKeyValuePairs('name"abc":5', ':', ' ,;', '\"', 'INVALID') as kv;
```

```text
┌─kv──┐
│ {}  │
└─────┘
```

unexpected\_quoting\_character\_strategy=accept

```sql
SELECT extractKeyValuePairs('name"abc:5', ':', ' ,;', '\"', 'ACCEPT') as kv;
```

```text
┌─kv────────────────┐
│ {'name"abc':'5'}  │
└───────────────────┘
```

```sql
SELECT extractKeyValuePairs('name"abc":5', ':', ' ,;', '\"', 'ACCEPT') as kv;
```

```text
┌─kv─────────────────┐
│ {'name"abc"':'5'}  │
└────────────────────┘
```

unexpected\_quoting\_character\_strategy=promote

```sql
SELECT extractKeyValuePairs('name"abc:5', ':', ' ,;', '\"', 'PROMOTE') as kv;
```

```text
┌─kv──┐
│ {}  │
└─────┘
```

```sql
SELECT extractKeyValuePairs('name"abc":5', ':', ' ,;', '\"', 'PROMOTE') as kv;
```

```text
┌─kv───────────┐
│ {'abc':'5'}  │
└──────────────┘
```

**Escape sequences without escape sequences support**

```sql
arthur :) select extractKeyValuePairs('age:a\\x0A\\n\\0') as kv

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

Query id: e9fd26ee-b41f-4a11-b17f-25af6fd5d356

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

**Syntax**

```sql
extractKeyValuePairs(data, [key_value_delimiter], [pair_delimiter], [quoting_character], [unexpected_quoting_character_strategy])
```

*Introduced in version 23.4.0.*

extractKeyValuePairsWithEscaping [#extractkeyvaluepairswithescaping]

Same as `extractKeyValuePairs` but with escaping support.

Escape sequences supported: `\x`, `\N`, `\a`, `\b`, `\e`, `\f`, `\n`, `\r`, `\t`, `\v` and `\0`.
Non standard escape sequences are returned as it is (including the backslash) unless they are one of the following:
`\\`, `'`, `"`, `backtick`, `/`, `=` or ASCII control characters (`c <= 31`).

This function will satisfy the use case where pre-escaping and post-escaping are not suitable. For instance, consider the following
input string: `a: "aaaa\"bbb"`. The expected output is: `a: aaaa\"bbbb`.

* Pre-escaping: Pre-escaping it will output: `a: "aaaa"bbb"` and `extractKeyValuePairs` will then output: `a: aaaa`
* Post-escaping: `extractKeyValuePairs` will output `a: aaaa\` and post-escaping will keep it as it is.

Leading escape sequences will be skipped in keys and will be considered invalid for values.

**Escape sequences with escape sequence support turned on**

```sql
arthur :) select extractKeyValuePairsWithEscaping('age:a\\x0A\\n\\0') as kv

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

Query id: 44c114f0-5658-4c75-ab87-4574de3a1645

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

**Syntax**

```sql
extractKeyValuePairsWithEscaping(data, [key_value_delimiter], [pair_delimiter], [quoting_character], [unexpected_quoting_character_strategy])
```

*Introduced in version 23.4.0.*

map [#map]

Creates a value of type `Map(key, value)` from key-value pairs.

**Syntax**

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

**Arguments**

* `key_n` — The keys of the map entries. [`Any`](/reference/data-types)
* `value_n` — The values of the map entries. [`Any`](/reference/data-types)

**Returned value**

Returns a map containing key:value pairs. [`Map(Any, Any)`](/reference/data-types/map)

**Examples**

**Usage example**

```sql title=Query
SELECT map('key1', number, 'key2', number * 2) FROM numbers(3)
```

```text title=Response
{'key1':0,'key2':0}
{'key1':1,'key2':2}
{'key1':2,'key2':4}
```

*Introduced in version 21.1.0.*

mapAdd [#mapadd]

Collect all the keys and sum corresponding values.

**Syntax**

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

**Arguments**

* `arg1[, arg2, ...]` — Maps or tuples of two arrays in which items in the first array represent keys, and the second array contains values for each key. [`Map(K, V)`](/reference/data-types/map) or [`Tuple(Array(T), Array(T))`](/reference/data-types/tuple)

**Returned value**

Returns a map or returns a tuple, where the first array contains the sorted keys and the second array contains values. [`Map(K, V)`](/reference/data-types/map) or [`Tuple(Array(T), Array(T))`](/reference/data-types/tuple)

**Examples**

**With Map type**

```sql title=Query
SELECT mapAdd(map(1, 1), map(1, 1))
```

```text title=Response
{1:2}
```

**With tuple**

```sql title=Query
SELECT mapAdd(([toUInt8(1), 2], [1, 1]), ([toUInt8(1), 2], [1, 1]))
```

```text title=Response
([1, 2], [2, 2])
```

*Introduced in version 20.7.0.*

mapAll [#mapall]

Tests whether a condition holds for all key-value pairs in a map.
`mapAll` is a higher-order function.
You can pass a lambda function to it as the first argument.

**Syntax**

```sql
mapAll([func,] map)
```

**Arguments**

* `func` — Lambda function. [`Lambda function`](/reference/functions/regular-functions/overview#arrow-operator-and-lambda)
* `map` — Map to check. [`Map(K, V)`](/reference/data-types/map)

**Returned value**

Returns `1` if all key-value pairs satisfy the condition, `0` otherwise. [`UInt8`](/reference/data-types/int-uint)

**Examples**

**Usage example**

```sql title=Query
SELECT mapAll((k, v) -> v = 1, map('k1', 1, 'k2', 2))
```

```text title=Response
0
```

*Introduced in version 23.4.0.*

mapApply [#mapapply]

Applies a function to each element of a map.

**Syntax**

```sql
mapApply(func, map)
```

**Arguments**

* `func` — Lambda function. [`Lambda function`](/reference/functions/regular-functions/overview#arrow-operator-and-lambda)
* `map` — Map to apply function to. [`Map(K, V)`](/reference/data-types/map)

**Returned value**

Returns a new map obtained from the original map by application of `func` for each element. [`Map(K, V)`](/reference/data-types/map)

**Examples**

**Usage example**

```sql title=Query
SELECT mapApply((k, v) -> (k, v * 2), map('k1', 1, 'k2', 2))
```

```text title=Response
{'k1':2,'k2':4}
```

*Introduced in version 22.3.0.*

mapConcat [#mapconcat]

Concatenates multiple maps based on the equality of their keys.
If elements with the same key exist in more than one input map, all elements are added to the result map, but only the first one is accessible via operator \[].

**Syntax**

```sql
mapConcat(maps)
```

**Arguments**

* `maps` — Arbitrarily many maps. [`Map`](/reference/data-types/map)

**Returned value**

Returns a map with concatenated maps passed as arguments. [`Map`](/reference/data-types/map)

**Examples**

**Usage example**

```sql title=Query
SELECT mapConcat(map('k1', 'v1'), map('k2', 'v2'))
```

```text title=Response
{'k1':'v1','k2':'v2'}
```

*Introduced in version 23.4.0.*

mapContainsKey [#mapcontainskey]

Determines if a key is contained in a map.

**Syntax**

```sql
mapContainsKey(map, key)
```

**Arguments**

* `map` — Map to search in. [`Map(K, V)`](/reference/data-types/map)
* `key` — Key to search for. Type must match the key type of the map. [`Any`](/reference/data-types)

**Returned value**

Returns 1 if map contains key, 0 if not. [`UInt8`](/reference/data-types/int-uint)

**Examples**

**Usage example**

```sql title=Query
SELECT mapContainsKey(map('k1', 'v1', 'k2', 'v2'), 'k1')
```

```text title=Response
1
```

*Introduced in version 21.2.0.*

mapContainsKeyLike [#mapcontainskeylike]

Checks whether map contains key `LIKE` specified pattern.

**Syntax**

```sql
mapContainsKeyLike(map, pattern)
```

**Arguments**

* `map` — Map to search in. [`Map(K, V)`](/reference/data-types/map)
* `pattern` — Pattern to match keys against. [`const String`](/reference/data-types/string)

**Returned value**

Returns `1` if `map` contains a key matching `pattern`, `0` otherwise. [`UInt8`](/reference/data-types/int-uint)

**Examples**

**Usage example**

```sql title=Query
CREATE TABLE tab (a Map(String, String))
ENGINE = MergeTree
ORDER BY tuple();

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

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

```text title=Response
┌─mapContainsKeyLike(a, 'a%')─┐
│                           1 │
│                           0 │
└─────────────────────────────┘
```

*Introduced in version 23.4.0.*

mapContainsValue [#mapcontainsvalue]

Determines if a value is contained in a map.

**Syntax**

```sql
mapContainsValue(map, value)
```

**Arguments**

* `map` — Map to search in. [`Map(K, V)`](/reference/data-types/map)
* `value` — Value to search for. Type must match the value type of map. [`Any`](/reference/data-types)

**Returned value**

Returns `1` if the map contains the value, `0` if not. [`UInt8`](/reference/data-types/int-uint)

**Examples**

**Usage example**

```sql title=Query
SELECT mapContainsValue(map('k1', 'v1', 'k2', 'v2'), 'v1')
```

```text title=Response
1
```

*Introduced in version 25.6.0.*

mapContainsValueLike [#mapcontainsvaluelike]

Checks whether a map contains a value `LIKE` the specified pattern.

**Syntax**

```sql
mapContainsValueLike(map, pattern)
```

**Arguments**

* `map` — Map to search in. [`Map(K, V)`](/reference/data-types/map)
* `pattern` — Pattern to match values against. [`const String`](/reference/data-types/string)

**Returned value**

Returns `1` if `map` contains a value matching `pattern`, `0` otherwise. [`UInt8`](/reference/data-types/int-uint)

**Examples**

**Usage example**

```sql title=Query
CREATE TABLE tab (a Map(String, String))
ENGINE = MergeTree
ORDER BY tuple();

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

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

```text title=Response
┌─mapContainsV⋯ke(a, 'a%')─┐
│                        1 │
│                        0 │
└──────────────────────────┘
```

*Introduced in version 25.5.0.*

mapExists [#mapexists]

Tests whether a condition holds for at least one key-value pair in a map.
`mapExists` is a higher-order function.
You can pass a lambda function to it as the first argument.

**Syntax**

```sql
mapExists([func,] map)
```

**Arguments**

* `func` — Optional. Lambda function. [`Lambda function`](/reference/functions/regular-functions/overview#arrow-operator-and-lambda)
* `map` — Map to check. [`Map(K, V)`](/reference/data-types/map)

**Returned value**

Returns `1` if at least one key-value pair satisfies the condition, `0` otherwise. [`UInt8`](/reference/data-types/int-uint)

**Examples**

**Usage example**

```sql title=Query
SELECT mapExists((k, v) -> v = 1, map('k1', 1, 'k2', 2))
```

```text title=Response
1
```

*Introduced in version 23.4.0.*

mapExtractKeyLike [#mapextractkeylike]

Give a map with string keys and a `LIKE` pattern, this function returns a map with elements where the key matches the pattern.

**Syntax**

```sql
mapExtractKeyLike(map, pattern)
```

**Arguments**

* `map` — Map to extract from. [`Map(K, V)`](/reference/data-types/map)
* `pattern` — Pattern to match keys against. [`const String`](/reference/data-types/string)

**Returned value**

Returns a map containing elements the key matching the specified pattern. If no elements match the pattern, an empty map is returned. [`Map(K, V)`](/reference/data-types/map)

**Examples**

**Usage example**

```sql title=Query
CREATE TABLE tab (a Map(String, String))
ENGINE = MergeTree
ORDER BY tuple();

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

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

```text title=Response
┌─mapExtractKeyLike(a, 'a%')─┐
│ {'abc':'abc'}              │
│ {}                         │
└────────────────────────────┘
```

*Introduced in version 23.4.0.*

mapExtractValueLike [#mapextractvaluelike]

Given a map with string values and a `LIKE` pattern, this function returns a map with elements where the value matches the pattern.

**Syntax**

```sql
mapExtractValueLike(map, pattern)
```

**Arguments**

* `map` — Map to extract from. [`Map(K, V)`](/reference/data-types/map)
* `pattern` — Pattern to match values against. [`const String`](/reference/data-types/string)

**Returned value**

Returns a map containing elements the value matching the specified pattern. If no elements match the pattern, an empty map is returned. [`Map(K, V)`](/reference/data-types/map)

**Examples**

**Usage example**

```sql title=Query
CREATE TABLE tab (a Map(String, String))
ENGINE = MergeTree
ORDER BY tuple();

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

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

```text title=Response
┌─mapExtractValueLike(a, 'a%')─┐
│ {'abc':'abc'}                │
│ {}                           │
└──────────────────────────────┘
```

*Introduced in version 25.5.0.*

mapFilter [#mapfilter]

Filters a map by applying a function to each map element.

**Syntax**

```sql
mapFilter(func, map)
```

**Arguments**

* `func` — Lambda function. [`Lambda function`](/reference/functions/regular-functions/overview#arrow-operator-and-lambda)
* `map` — Map to filter. [`Map(K, V)`](/reference/data-types/map)

**Returned value**

Returns a map containing only the elements in the map for which `func` returns something other than `0`. [`Map(K, V)`](/reference/data-types/map)

**Examples**

**Usage example**

```sql title=Query
SELECT mapFilter((k, v) -> v > 1, map('k1', 1, 'k2', 2))
```

```text title=Response
{'k2':2}
```

*Introduced in version 22.3.0.*

mapFromArrays [#mapfromarrays]

Creates a map from an array or map of keys and an array or map of values.
The function is a convenient alternative to syntax `CAST([...], 'Map(key_type, value_type)')`.

**Syntax**

```sql
mapFromArrays(keys, values)
```

**Arguments**

* `keys` — Array or map of keys to create the map from. [`Array`](/reference/data-types/array) or [`Map`](/reference/data-types/map)
* `values` — Array or map of values to create the map from. [`Array`](/reference/data-types/array) or [`Map`](/reference/data-types/map)

**Returned value**

Returns a map with keys and values constructed from the key array and value array/map. [`Map`](/reference/data-types/map)

**Examples**

**Basic usage**

```sql title=Query
SELECT mapFromArrays(['a', 'b', 'c'], [1, 2, 3])
```

```text title=Response
{'a':1,'b':2,'c':3}
```

**With map inputs**

```sql title=Query
SELECT mapFromArrays([1, 2, 3], map('a', 1, 'b', 2, 'c', 3))
```

```text title=Response
{1:('a', 1), 2:('b', 2), 3:('c', 3)}
```

*Introduced in version 23.3.0.*

mapKeys [#mapkeys]

Returns the keys of a given map.
This function can be optimized by enabling setting [`optimize_functions_to_subcolumns`](/reference/settings/session-settings/optimize#optimize_functions_to_subcolumns).
With the setting enabled, the function only reads the `keys` subcolumn instead of the entire map.
The query `SELECT mapKeys(m) FROM table` is transformed to `SELECT m.keys FROM table`.

**Syntax**

```sql
mapKeys(map)
```

**Arguments**

* `map` — Map to extract keys from. [`Map(K, V)`](/reference/data-types/map)

**Returned value**

Returns array containing all keys from the map. [`Array(T)`](/reference/data-types/array)

**Examples**

**Usage example**

```sql title=Query
SELECT mapKeys(map('k1', 'v1', 'k2', 'v2'))
```

```text title=Response
['k1','k2']
```

*Introduced in version 21.2.0.*

mapPartialReverseSort [#mappartialreversesort]

Sorts the elements of a map in descending order with additional limit argument allowing partial sorting.
If the func function is specified, the sorting order is determined by the result of the func function applied to the keys and values of the map.

**Syntax**

```sql
mapPartialReverseSort([func,] limit, map)
```

**Arguments**

* `func` — Optional. Lambda function. [`Lambda function`](/reference/functions/regular-functions/overview#arrow-operator-and-lambda)
* `limit` — Elements in the range `[1..limit]` are sorted. [`(U)Int*`](/reference/data-types/int-uint)
* `map` — Map to sort. [`Map(K, V)`](/reference/data-types/map)

**Returned value**

Returns a partially sorted map in descending order. [`Map(K, V)`](/reference/data-types/map)

**Examples**

**Usage example**

```sql title=Query
SELECT mapPartialReverseSort((k, v) -> v, 2, map('k1', 3, 'k2', 1, 'k3', 2))
```

```text title=Response
{'k1':3,'k3':2,'k2':1}
```

*Introduced in version 23.4.0.*

mapPartialSort [#mappartialsort]

Sorts the elements of a map in ascending order with additional limit argument allowing partial sorting.
If the func function is specified, the sorting order is determined by the result of the func function applied to the keys and values of the map.

**Syntax**

```sql
mapPartialSort([func,] limit, map)
```

**Arguments**

* `func` — Optional. Lambda function. [`Lambda function`](/reference/functions/regular-functions/overview#arrow-operator-and-lambda)
* `limit` — Elements in the range `[1..limit]` are sorted. [`(U)Int*`](/reference/data-types/int-uint)
* `map` — Map to sort. [`Map(K, V)`](/reference/data-types/map)

**Returned value**

Returns a partially sorted map. [`Map(K, V)`](/reference/data-types/map)

**Examples**

**Usage example**

```sql title=Query
SELECT mapPartialSort((k, v) -> v, 2, map('k1', 3, 'k2', 1, 'k3', 2))
```

```text title=Response
{'k2':1,'k3':2,'k1':3}
```

*Introduced in version 23.4.0.*

mapPopulateSeries [#mappopulateseries]

Fills missing key-value pairs in a map with integer keys.
To support extending the keys beyond the largest value, a maximum key can be specified.
More specifically, the function returns a map in which the keys form a series from the smallest to the largest key (or max argument if specified) with step size of 1, and corresponding values.
If no value is specified for a key, a default value is used as value.
In case keys repeat, only the first value (in order of appearance) is associated with the key.

**Syntax**

```sql
mapPopulateSeries(map[, max]) | mapPopulateSeries(keys, values[, max])
```

**Arguments**

* `map` — Map with integer keys. [`Map((U)Int*, V)`](/reference/data-types/map)
* `keys` — Array of keys. [`Array(T)`](/reference/data-types/array)
* `values` — Array of values. [`Array(T)`](/reference/data-types/array)
* `max` — Optional. Maximum key value. [`Int8`](/reference/data-types/int-uint) or [`Int16`](/reference/data-types/int-uint) or [`Int32`](/reference/data-types/int-uint) or [`Int64`](/reference/data-types/int-uint) or [`Int128`](/reference/data-types/int-uint) or [`Int256`](/reference/data-types/int-uint)

**Returned value**

Returns a map or a tuple of two arrays where the first has keys in sorted order, and the second values for the corresponding keys. [`Map(K, V)`](/reference/data-types/map) or [`Tuple(Array(UInt*), Array(Any))`](/reference/data-types/tuple)

**Examples**

**With Map type**

```sql title=Query
SELECT mapPopulateSeries(map(1, 10, 5, 20), 6)
```

```text title=Response
{1:10, 2:0, 3:0, 4:0, 5:20, 6:0}
```

**With mapped arrays**

```sql title=Query
SELECT mapPopulateSeries([1, 2, 4], [11, 22, 44], 5)
```

```text title=Response
([1, 2, 3, 4, 5], [11, 22, 0, 44, 0])
```

*Introduced in version 20.10.0.*

mapReverseSort [#mapreversesort]

Sorts the elements of a map in descending order.
If the func function is specified, the sorting order is determined by the result of the func function applied to the keys and values of the map.

**Syntax**

```sql
mapReverseSort([func,] map)
```

**Arguments**

* `func` — Optional. Lambda function. [`Lambda function`](/reference/functions/regular-functions/overview#arrow-operator-and-lambda)
* `map` — Map to sort. [`Map(K, V)`](/reference/data-types/map)

**Returned value**

Returns a map sorted in descending order. [`Map(K, V)`](/reference/data-types/map)

**Examples**

**Usage example**

```sql title=Query
SELECT mapReverseSort((k, v) -> v, map('k1', 3, 'k2', 1, 'k3', 2))
```

```text title=Response
{'k1':3,'k3':2,'k2':1}
```

*Introduced in version 23.4.0.*

mapSort [#mapsort]

Sorts the elements of a map in ascending order.
If the func function is specified, the sorting order is determined by the result of the func function applied to the keys and values of the map.

**Syntax**

```sql
mapSort([func,] map)
```

**Arguments**

* `func` — Optional. Lambda function. [`Lambda function`](/reference/functions/regular-functions/overview#arrow-operator-and-lambda)
* `map` — Map to sort. [`Map(K, V)`](/reference/data-types/map)

**Returned value**

Returns a map sorted in ascending order. [`Map(K, V)`](/reference/data-types/map)

**Examples**

**Usage example**

```sql title=Query
SELECT mapSort((k, v) -> v, map('k1', 3, 'k2', 1, 'k3', 2))
```

```text title=Response
{'k2':1,'k3':2,'k1':3}
```

*Introduced in version 23.4.0.*

mapSubtract [#mapsubtract]

Collect all the keys and subtract corresponding values.

**Syntax**

```sql
mapSubtract(arg1[, arg2, ...])
```

**Arguments**

* `arg1[, arg2, ...]` — Maps or tuples of two arrays in which items in the first array represent keys, and the second array contains values for each key. [`Map(K, V)`](/reference/data-types/map) or [`Tuple(Array(T), Array(T))`](/reference/data-types/tuple)

**Returned value**

Returns one map or tuple, where the first array contains the sorted keys and the second array contains values. [`Map(K, V)`](/reference/data-types/map) or [`Tuple(Array(T), Array(T))`](/reference/data-types/tuple)

**Examples**

**With Map type**

```sql title=Query
SELECT mapSubtract(map(1, 1), map(1, 1))
```

```text title=Response
{1:0}
```

**With tuple map**

```sql title=Query
SELECT mapSubtract(([toUInt8(1), 2], [toInt32(1), 1]), ([toUInt8(1), 2], [toInt32(2), 1]))
```

```text title=Response
([1, 2], [-1, 0])
```

*Introduced in version 20.7.0.*

mapUpdate [#mapupdate]

For two maps, returns the first map with values updated on the values for the corresponding keys in the second map.

**Syntax**

```sql
mapUpdate(map1, map2)
```

**Arguments**

* `map1` — The map to update. [`Map(K, V)`](/reference/data-types/map)
* `map2` — The map to use for updating. [`Map(K, V)`](/reference/data-types/map)

**Returned value**

Returns `map1` with values updated from values for the corresponding keys in `map2`. [`Map(K, V)`](/reference/data-types/map)

**Examples**

**Basic usage**

```sql title=Query
SELECT mapUpdate(map('key1', 0, 'key3', 0), map('key1', 10, 'key2', 10))
```

```text title=Response
{'key3':0,'key1':10,'key2':10}
```

*Introduced in version 22.3.0.*

mapValues [#mapvalues]

Returns the values of a given map.
This function can be optimized by enabling setting [`optimize_functions_to_subcolumns`](/reference/settings/session-settings/optimize#optimize_functions_to_subcolumns).
With the setting enabled, the function only reads the `values` subcolumn instead of the entire map.
The query `SELECT mapValues(m) FROM table` is transformed to `SELECT m.values FROM table`.

**Syntax**

```sql
mapValues(map)
```

**Arguments**

* `map` — Map to extract values from. [`Map(K, V)`](/reference/data-types/map)

**Returned value**

Returns an array containing all the values from the map. [`Array(T)`](/reference/data-types/array)

**Examples**

**Usage example**

```sql title=Query
SELECT mapValues(map('k1', 'v1', 'k2', 'v2'))
```

```text title=Response
['v1','v2']
```

*Introduced in version 21.2.0.*
