apoc.map.get

详细信息

语法

apoc.map.get(map, key [, value, fail ])

描述

返回指定键对应的值。如果指定的键不存在且未提供默认值,该函数将抛出异常。

参数

名称

类型

描述

Map

MAP

要从中提取值的映射(map)。

键 (key)

STRING

要提取的键。

ANY

指定键的默认值。默认值为:null

fail

布尔值 (BOOLEAN)

如果键不存在且未提供默认值,当此项为 true 时将抛出异常,否则返回 null。默认值为:true

返回

ANY

使用示例

当尝试查找不存在的键 missingKey 且未提供默认值时,以下代码会抛出异常

WITH {name:"Cristiano Ronaldo",country:"Portugal",dob:date("1985-02-05")} AS map
RETURN apoc.map.get(map, "missingKey") AS output;
结果
输出

Neo.ClientError.Procedure.ProcedureCallFailed: Failed to invoke function apoc.map.get: Caused by: java.lang.IllegalArgumentException: Key missingKey is not of one of the existing keys [country, dob, name]

当尝试查找不存在的键 missingKey 时,以下代码返回默认值 defaultValue

WITH {name:"Cristiano Ronaldo", country:"Portugal", dob:date("1985-02-05")} AS map
RETURN apoc.map.get(map, "missingKey", "defaultValue") AS output;
结果
输出

"defaultValue"