apoc.map

Qualified Name Type

Qualified Name	Type
apoc.map.clean `apoc.map.clean(map MAP<STRING, ANY>, keys LIST<STRING>, values LIST<ANY>)` - filters the keys and values contained in the given `LIST<ANY>` values.	Function
apoc.map.flatten `apoc.map.flatten(map MAP<STRING, ANY>, delimiter STRING)` - flattens nested items in the given `MAP`. This function is the reverse of the `apoc.map.unflatten` function.	Function
apoc.map.fromLists `apoc.map.fromLists(keys LIST<STRING>, values LIST<ANY>)` - creates a `MAP` from the keys and values in the given `LIST<ANY>` values.	Function
apoc.map.fromNodes `apoc.map.fromNodes(label STRING, prop STRING)` - returns a `MAP` of the given prop to the node of the given label.	Function
apoc.map.fromPairs `apoc.map.updateTree(tree MAP<STRING, ANY>, key STRING, data LIST<LIST<key ANY, value ANY>>)`- adds the data `MAP` on each level of the nested tree, where the key-value pairs match.	Function
apoc.map.fromValues `apoc.map.fromValues(values LIST<ANY>)` - creates a `MAP` from the alternating keys and values in the given `LIST<ANY>`.	Function
apoc.map.get `apoc.map.get(map MAP<STRING, ANY>, key STRING, value ANY, fail BOOLEAN)` - returns a value for the given key. If the given key does not exist, or lacks a default value, this function will throw an exception.	Function
apoc.map.groupBy `apoc.map.groupBy(values LIST<ANY>, key STRING)` - creates a `MAP` of the `LIST<ANY>` keyed by the given property, with single values.	Function
apoc.map.groupByMulti `apoc.map.groupByMulti(values LIST<ANY>, key STRING)` - creates a `MAP` of the `LIST<ANY>` values keyed by the given property, with the `LIST<ANY>` values.	Function
apoc.map.merge `apoc.map.merge(map1 MAP<STRING, ANY>, map2 MAP<STRING, ANY>)` - merges the two given `MAP` values into one `MAP`.	Function
apoc.map.mergeList `apoc.map.mergeList(maps LIST<MAP<STRING, Value>>)` - merges all `MAP` values in the given `LIST<MAP<STRING, ANY>>` into one `MAP`.	Function
apoc.map.mget `apoc.map.mget(map MAP<STRING, ANY>, keys LIST<STRING>, values LIST<ANY>, fail BOOLEAN)` - returns a `LIST<ANY>` for the given keys. If one of the keys does not exist, or lacks a default value, this function will throw an exception.	Function
apoc.map.removeKey `apoc.map.removeKey(map MAP<STRING, ANY>, key STRING, config MAP<STRING, ANY>)` - removes the given key from the `MAP` (recursively if recursive is true).	Function
apoc.map.removeKeys `apoc.map.removeKeys(map MAP<STRING, ANY>, keys LIST<STRING>, config MAP<STRING, ANY>)` - removes the given keys from the `MAP` (recursively if recursive is true).	Function
apoc.map.setEntry `apoc.map.setEntry(map MAP<STRING, ANY>, key STRING, value ANY)` - adds or updates the given entry in the `MAP`.	Function
apoc.map.setKey `apoc.map.setKey(map MAP<STRING, ANY>, key STRING, value ANY)` - adds or updates the given entry in the `MAP`.	Function
apoc.map.setLists `apoc.map.setLists(map MAP<STRING, ANY>, keys LIST<STRING>, values LIST<ANY>)` - adds or updates the given keys/value pairs provided in `LIST<ANY>` format (e.g. [key1, key2],[value1, value2]) in a `MAP`.	Function
apoc.map.setPairs `apoc.map.setPairs(map MAP<STRING, ANY>, pairs [[key ANY, value ANY]])` - adds or updates the given key/value pairs (e.g. [key1,value1],[key2,value2]) in a `MAP`.	Function
apoc.map.setValues `apoc.map.setValues(map MAP<STRING, ANY>, pairs [key ANY, value ANY])` - adds or updates the alternating key/value pairs (e.g. [key1,value1,key2,value2]) in a `MAP`.	Function
apoc.map.sortedProperties `apoc.map.sortedProperties(map MAP<STRING, ANY>, ignoreCase BOOLEAN)` - returns a `LIST<ANY>` of key/value pairs. The pairs are sorted alphabetically by key, with optional case sensitivity.	Function
apoc.map.submap `apoc.map.submap(map MAP<STRING, ANY>, keys LIST<STRING>, values LIST<ANY>, fail BOOLEAN)` - returns a sub-map for the given keys. If one of the keys does not exist, or lacks a default value, this function will throw an exception.	Function
apoc.map.unflatten `apoc.map.unflatten(map MAP<STRING, ANY>, delimiter STRING)` - unflattens items in the given `MAP` to nested items. This function is the reverse of the `apoc.map.flatten` function.	Function
apoc.map.updateTree `apoc.map.updateTree(tree MAP<STRING, ANY>, key STRING, data LIST<LIST<key ANY, value ANY>>)`- adds the data `MAP` on each level of the nested tree, where the key-value pairs match.	Function
apoc.map.values `apoc.map.values(map MAP<STRING, ANY>, keys LIST<STRING>, addNullsForMissing BOOLEAN)` - returns a `LIST<ANY>` indicated by the given keys (returns a null value if a given key is missing).	Function

apoc.map.clean

apoc.map.clean(map MAP<STRING, ANY>, keys LIST<STRING>, values LIST<ANY>) - filters the keys and values contained in the given LIST<ANY> values.

Function

apoc.map.flatten

apoc.map.flatten(map MAP<STRING, ANY>, delimiter STRING) - flattens nested items in the given MAP. This function is the reverse of the apoc.map.unflatten function.

Function

apoc.map.fromLists

apoc.map.fromLists(keys LIST<STRING>, values LIST<ANY>) - creates a MAP from the keys and values in the given LIST<ANY> values.

Function

apoc.map.fromNodes

apoc.map.fromNodes(label STRING, prop STRING) - returns a MAP of the given prop to the node of the given label.

Function

apoc.map.fromPairs

apoc.map.updateTree(tree MAP<STRING, ANY>, key STRING, data LIST<LIST<key ANY, value ANY>>)- adds the data MAP on each level of the nested tree, where the key-value pairs match.

Function

apoc.map.fromValues

apoc.map.fromValues(values LIST<ANY>) - creates a MAP from the alternating keys and values in the given LIST<ANY>.

Function

apoc.map.get

apoc.map.get(map MAP<STRING, ANY>, key STRING, value ANY, fail BOOLEAN) - returns a value for the given key. If the given key does not exist, or lacks a default value, this function will throw an exception.

Function

apoc.map.groupBy

apoc.map.groupBy(values LIST<ANY>, key STRING) - creates a MAP of the LIST<ANY> keyed by the given property, with single values.

Function

apoc.map.groupByMulti

apoc.map.groupByMulti(values LIST<ANY>, key STRING) - creates a MAP of the LIST<ANY> values keyed by the given property, with the LIST<ANY> values.

Function

apoc.map.merge

apoc.map.merge(map1 MAP<STRING, ANY>, map2 MAP<STRING, ANY>) - merges the two given MAP values into one MAP.

Function

apoc.map.mergeList

apoc.map.mergeList(maps LIST<MAP<STRING, Value>>) - merges all MAP values in the given LIST<MAP<STRING, ANY>> into one MAP.

Function

apoc.map.mget

apoc.map.mget(map MAP<STRING, ANY>, keys LIST<STRING>, values LIST<ANY>, fail BOOLEAN) - returns a LIST<ANY> for the given keys. If one of the keys does not exist, or lacks a default value, this function will throw an exception.

Function

apoc.map.removeKey

apoc.map.removeKey(map MAP<STRING, ANY>, key STRING, config MAP<STRING, ANY>) - removes the given key from the MAP (recursively if recursive is true).

Function

apoc.map.removeKeys

apoc.map.removeKeys(map MAP<STRING, ANY>, keys LIST<STRING>, config MAP<STRING, ANY>) - removes the given keys from the MAP (recursively if recursive is true).

Function

apoc.map.setEntry

apoc.map.setEntry(map MAP<STRING, ANY>, key STRING, value ANY) - adds or updates the given entry in the MAP.

Function

apoc.map.setKey

apoc.map.setKey(map MAP<STRING, ANY>, key STRING, value ANY) - adds or updates the given entry in the MAP.

Function

apoc.map.setLists

apoc.map.setLists(map MAP<STRING, ANY>, keys LIST<STRING>, values LIST<ANY>) - adds or updates the given keys/value pairs provided in LIST<ANY> format (e.g. [key1, key2],[value1, value2]) in a MAP.

Function

apoc.map.setPairs

apoc.map.setPairs(map MAP<STRING, ANY>, pairs [[key ANY, value ANY]]) - adds or updates the given key/value pairs (e.g. [key1,value1],[key2,value2]) in a MAP.

Function

apoc.map.setValues

apoc.map.setValues(map MAP<STRING, ANY>, pairs [key ANY, value ANY]) - adds or updates the alternating key/value pairs (e.g. [key1,value1,key2,value2]) in a MAP.

Function

apoc.map.sortedProperties

apoc.map.sortedProperties(map MAP<STRING, ANY>, ignoreCase BOOLEAN) - returns a LIST<ANY> of key/value pairs. The pairs are sorted alphabetically by key, with optional case sensitivity.

Function

apoc.map.submap

apoc.map.submap(map MAP<STRING, ANY>, keys LIST<STRING>, values LIST<ANY>, fail BOOLEAN) - returns a sub-map for the given keys. If one of the keys does not exist, or lacks a default value, this function will throw an exception.

Function

apoc.map.unflatten

apoc.map.unflatten(map MAP<STRING, ANY>, delimiter STRING) - unflattens items in the given MAP to nested items. This function is the reverse of the apoc.map.flatten function.

Function

apoc.map.updateTree

apoc.map.updateTree(tree MAP<STRING, ANY>, key STRING, data LIST<LIST<key ANY, value ANY>>)- adds the data MAP on each level of the nested tree, where the key-value pairs match.

Function

apoc.map.values

apoc.map.values(map MAP<STRING, ANY>, keys LIST<STRING>, addNullsForMissing BOOLEAN) - returns a LIST<ANY> indicated by the given keys (returns a null value if a given key is missing).

Function