pyspark.sql.functions.map_contains_key

pyspark.sql.functions.map_contains_key(col: ColumnOrName, value: Any) → pyspark.sql.column.Column

Returns true if the map contains the key.

New in version 3.4.0.

Changed in version 3.4.0: Supports Spark Connect.

Parameters

colColumn or str

name of column or expression

value

a literal value

Returns

Column

True if key is in the map and False otherwise.

Examples

>>> from pyspark.sql.functions import map_contains_key
>>> df = spark.sql("SELECT map(1, 'a', 2, 'b') as data")
>>> df.select(map_contains_key("data", 1)).show()
+---------------------------------+
|array_contains(map_keys(data), 1)|
+---------------------------------+
|                             true|
+---------------------------------+
>>> df.select(map_contains_key("data", -1)).show()
+----------------------------------+
|array_contains(map_keys(data), -1)|
+----------------------------------+
|                             false|
+----------------------------------+

previous

pyspark.sql.functions.array_repeat

next

pyspark.sql.functions.map_keys