Snowpark Scala API Reference1.20.0 < Back


# Packages

-  package root
  Definition Classes
    root
-  package com
  Definition Classes
    root
-  package snowflake
  Definition Classes
    com
-  package snowpark
  Definition Classes
    snowflake
-  package types

  This package contains all Snowpark logical types.

  This package contains all Snowpark logical types.

  Definition Classes
    snowpark
  Since

    0.1.0

-  package udaf
  Definition Classes
    snowpark
-  package udtf
  Definition Classes
    snowpark
- AggregateFunction
- AsyncJob
- CaseExpr
- Column
- CopyableDataFrame
- CopyableDataFrameAsyncActor
- DataFrame
- DataFrameAsyncActor
- DataFrameNaFunctions
- DataFrameReader
- DataFrameStatFunctions
- DataFrameWriter
- DataFrameWriterAsyncActor
- DeleteResult
- FileOperation
- GetResult
- GroupingSets
- HasCachedResult
- MatchedClauseBuilder
- MergeBuilder
- MergeBuilderAsyncActor
- MergeResult
- MergeTypedAsyncJob
- NotMatchedClauseBuilder
- PublicPreview
- PutResult
- RelationalGroupedDataFrame
- Row
- SProcRegistration
- SaveMode
- Session
- SnowparkClientException
- StoredProcedure
- TableFunction
- TypedAsyncJob
- UDAFRegistration
- UDFRegistration
- UDTFRegistration
- Updatable
- UpdatableAsyncActor
- UpdateResult
- UserDefinedFunction
- Window
- WindowSpec
- WriteFileResult
- functions
- tableFunctions

c

com.snowflake.snowpark

# MatchedClauseBuilder

###

#### class MatchedClauseBuilder extends AnyRef

Builder for a matched clause. It provides APIs to build update and delete actions

Since

  0.7.0

Linear Supertypes
AnyRef, Any

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. MatchedClauseBuilder
2. AnyRef
3. Any

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##: Int
   Definition Classes
     AnyRef → Any
3.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
4.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
5.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
6.  def delete(): MergeBuilder

   Defines a delete action for the matched clause, when a row in target is matched, delete it from target.

   Defines a delete action for the matched clause, when a row in target is matched, delete it from target. Returns an updated MergeBuilder with the new clause added.

   For example:

       target.merge(source, target("id") === source("id"))
       .whenMatched.delete()

   Adds a matched clause where a row in target is matched if its id equals the id of a row in the DataFrame source. For all such rows, delete it from target.

   returns

     MergeBuilder

   Since

     0.7.0

7.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
8.  def equals(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef → Any
9.  final def getClass(): Class[_ <: AnyRef]
   Definition Classes
     AnyRef → Any
   Annotations
     @HotSpotIntrinsicCandidate() @native()
10.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @HotSpotIntrinsicCandidate() @native()
11.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
12.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @HotSpotIntrinsicCandidate() @native()
14.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @HotSpotIntrinsicCandidate() @native()
15.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
16.  def toString(): String
    Definition Classes
      AnyRef → Any
17.  def update(assignments: Map[Column, Column]): MergeBuilder

    Defines an update action for the matched clause, when a row in target is matched, update the row in target with <assignments>, where the key specifies column name and value specifies its assigned value.

    Defines an update action for the matched clause, when a row in target is matched, update the row in target with <assignments>, where the key specifies column name and value specifies its assigned value. Returns an updated MergeBuilder with the new clause added.

    For example:

        target.merge(source, target("id") === source("id"))
        .whenMatched.update(Map(target("value") -> source("value")))

    Adds a matched clause where a row in target is matched if its id equals the id of a row in the DataFrame source. For all such rows, update its value to the value of the corresponding row in source.

    returns

      MergeBuilder

    Since

      0.7.0

18.  def update[T](assignments: Map[String, Column])(implicit arg0: ClassTag[T]): MergeBuilder

    Defines an update action for the matched clause, when a row in target is matched, update the row in target with <assignments>, where the key specifies column name and value specifies its assigned value.

    Defines an update action for the matched clause, when a row in target is matched, update the row in target with <assignments>, where the key specifies column name and value specifies its assigned value. Returns an updated MergeBuilder with the new clause added.

    For example:

        target.merge(source, target("id") === source("id"))
        .whenMatched.update(Map("value" -> source("value")))

    Adds a matched clause where a row in target is matched if its id equals the id of a row in the DataFrame source. For all such rows, update its value to the value of the corresponding row in source.

    returns

      MergeBuilder

    Since

      0.7.0

19.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
20.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()
21.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])

### Deprecated Value Members

1.  def finalize(): Unit
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.Throwable]) @Deprecated
   Deprecated

     (Since version 9)

### Inherited from AnyRef

### Inherited from Any

### transform

### Ungrouped