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

title	description	aliases	menu	weight	introduced
dict.get() function	The `dict.get()` function returns the value of a specified key in a dictionary or a default value if the key does not exist.	/influxdb/v2.0/reference/flux/stdlib/dict/get/ /influxdb/cloud/reference/flux/stdlib/dict/get/	flux_0_x_ref name parent dict.get dict	301	0.97.0

The dict.get() function returns the value of a specified key in a dictionary or a default value if the key does not exist.

import "dict"

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

Parameters

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

dict

Dictionary to return a value from.

key

Key to return from the dictionary.

default

Default value to return if the key does not exist in the dictionary. Must be the same type as values in the dictionary.

Examples

Return a property of a dictionary

import "dict"

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

dict.get(dict: d, key: 1, default: "")

// Returns foo