docs-v2/content/flux/v0.x/stdlib/dict/remove.md

title	description	aliases	menu	weight	introduced
dict.remove() function	The `dict.remove()` function removes a key value pair from a dictionary and returns an updated dictionary.	/influxdb/v2.0/reference/flux/stdlib/dict/remove/ /influxdb/cloud/reference/flux/stdlib/dict/remove/	flux_0_x_ref name parent dict.remove dict	301	0.97.0

The dict.remove() function removes a key value pair from a dictionary and returns an updated dictionary.

import "dict"

dict.remove(dict: [1: "foo", 2: "bar"], key: 1)

Parameters

{{< req "All paremeters are required" >}}

dict

Dictionary to remove a key-value pair from.

key

Key to remove from the dictionary. Must be the same type as existing keys in the dictionary.

Examples

Remove a property from a dictionary

import "dict"

d = [1: "foo", 2: "bar"]

dNew = dict.remove(dict: d, key: 1)

// Verify the key-value pairs was removed

dict.get(dict: dNew, key: 1, default: "")
// Returns an empty string

dict.get(dict: dNew, key: 2, default: "")
// Returns bar