snowflake.snowpark.WhenMatchedClause¶

class snowflake.snowpark.WhenMatchedClause(condition: Optional[Column] = None)[source]¶

Bases: object

A matched clause for the Table.merge() action. It matches all remaining rows in the target Table that satisfy join_expr while also satisfying condition, if it is provided. You can use functions.when_matched() to instantiate this class.

Parameters:

condition – An optional Column object representing the specified condition. For example, col("a") == 1.

Methods

delete()	Defines a delete action for the matched clause and returns an updated WhenMatchedClause with the new delete action added.
update(assignments)	Defines an update action for the matched clause and returns an updated WhenMatchedClause with the new update action added.