snowflake.snowpark.functions.map_delete

snowflake.snowpark.functions.map_delete(map_col: Union[snowflake.snowpark.column.Column, str], *keys: Union[snowflake.snowpark.column.Column, str]) → Column[source] (https://github.com/snowflakedb/snowpark-python/blob/v1.47.0/src/snowflake/snowpark/_functions/scalar_functions.py#L2069-L2096)

Returns a map consisting of the input map with one or more keys removed.

Parameters:

  • map_col (ColumnOrName) – The map used to remove keys.

  • *keys (ColumnOrName) – Keys to remove.

Returns:

A map with the specified keys removed.

Return type:

Column

Example:

>>> from snowflake.snowpark.functions import col, lit, to_variant
>>> df = session.sql("""
... SELECT {'a':1,'b':2,'c':3}::MAP(VARCHAR,NUMBER) as map_col
... union all
... SELECT {'c':3,'d':4,'e':5}::MAP(VARCHAR,NUMBER) as map_col
... """)
>>> df.select(to_variant(map_delete(col("map_col"), lit("c"), lit("d"))).alias("result")).collect()
[Row(RESULT='{\n  "a": 1,\n  "b": 2\n}'), Row(RESULT='{\n  "e": 5\n}')]