map.removeKey

​

Description

​

Syntax

flex.map.removeKey(map, key)

​

Parameters

​

Returns

​

Examples

​

Example 1: Basic Key Removal

WITH {name: 'Alice', age: 30, email: 'alice@example.com'} AS user
RETURN flex.map.removeKey(user, 'email') AS sanitized

sanitized
-----------------------
{name: 'Alice', age: 30}

​

Example 2: Removing Sensitive Data

MATCH (u:User)
WITH properties(u) AS userProps
RETURN u.id, flex.map.removeKey(userProps, 'password') AS safeProps

​

Example 3: Cleaning Response Data

MATCH (p:Product {id: 123})
WITH properties(p) AS props
WITH flex.map.removeKey(props, 'internalId') AS cleaned
RETURN cleaned AS product

​

Example 4: Removing Non-Existent Key

WITH {a: 1, b: 2} AS map
RETURN flex.map.removeKey(map, 'c') AS result

result
---------
{a: 1, b: 2}

​

Notes

• Returns empty map if input is not a valid object or is null
• If key is null, returns a shallow copy of the map
• If the key doesn’t exist, returns a copy with all original properties
• Creates a new map; does not modify the original
• Useful for sanitizing data, removing sensitive fields, or filtering properties

​

See Also

• map.removeKeys - Remove multiple keys at once
• map.submap - Keep only specific keys (inverse operation)
• map.merge - Combine multiple maps

​

Frequently Asked Questions