Snowpark Scala API Reference 1.19.0 - com.snowflake.snowpark.udaf.UDAF1
Keywords: Snowpark Scala API Reference 1.19.0 com.snowflake.snowpark.udaf.UDAF1

Snowpark Scala API Reference1.19.0 < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package com
  Definition Classes
    root
-  package snowflake
  Definition Classes
    com
-  package snowpark
  Definition Classes
    snowflake
-  package udaf
  Definition Classes
    snowpark
- UDAF
- UDAF1
- UDAF10
- UDAF11
- UDAF12
- UDAF13
- UDAF14
- UDAF15
- UDAF16
- UDAF17
- UDAF18
- UDAF19
- UDAF2
- UDAF20
- UDAF21
- UDAF22
- UDAF3
- UDAF4
- UDAF5
- UDAF6
- UDAF7
- UDAF8
- UDAF9

c

com.snowflake.snowpark.udaf

# UDAF1 

###

#### abstract class UDAF1[S, O, A0] extends UDAF

The Scala UDAF (user-defined aggregate function) abstract class that has 1 argument.

S

  The type of the aggregation state.

O

  The type of the output value.

Since

  1.19.0

Linear Supertypes
UDAF, Serializable, AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. UDAF1
2. UDAF
3. Serializable
4. AnyRef
5. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new UDAF1()(implicit a0Tag: scala.reflect.api.JavaUniverse.TypeTag[A0])

### Abstract Value Members

1.  abstract def accumulate(state: S, arg0: A0): S

   Updates the aggregation state with a new input row.

   Updates the aggregation state with a new input row.

   state

     The current aggregation state.

   arg0

     The input value for argument 1.

   returns

     The updated aggregation state.

   Since

     1.19.0

2.  abstract def initialize(): S

   returns

     The initial state of the aggregation.

   Since

     1.19.0

3.  abstract def merge(state1: S, state2: S): S

   Merges two aggregation states into one.

   Merges two aggregation states into one.

   state1

     The first aggregation state.

   state2

     The second aggregation state.

   returns

     The merged aggregation state.

   Since

     1.19.0

4.  abstract def outputType(): DataType

   A DataType that describes the type of the value returned by the terminate() method.

   A DataType that describes the type of the value returned by the terminate() method.

   For example, if a UDAF returns an integer value, outputType() should return IntegerType: {{ override def outputType(): DataType = IntegerType }}

   returns

     A DataType describing the output type.

   Definition Classes
     UDAF
   Since

     1.19.0

5.  abstract def terminate(state: S): O

   Produces the final output value from the aggregation state.

   Produces the final output value from the aggregation state.

   state

     The final aggregation state.

   returns

     The output value.

   Since

     1.19.0

### Concrete 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( ... ) @native() @HotSpotIntrinsicCandidate()
6.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
7.  def equals(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
8.  final def getClass(): Class[_]
   Definition Classes
     AnyRef → Any
   Annotations
     @native() @HotSpotIntrinsicCandidate()
9.  def hashCode(): Int
   Definition Classes
     AnyRef → Any
   Annotations
     @native() @HotSpotIntrinsicCandidate()
10.  def inputSchema(): StructType

    A StructType that describes the input schema of the aggregate function.

    A StructType that describes the input schema of the aggregate function. By default, returns an empty StructType.

    returns

      A StructType describing the input schema.

    Definition Classes
      UDAF
    Since

      1.19.0

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
      @native() @HotSpotIntrinsicCandidate()
14.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @HotSpotIntrinsicCandidate()
15.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
16.  def toString(): String
    Definition Classes
      AnyRef → Any
17.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
18.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... ) @native()
19.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

### Deprecated Value Members

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

### Inherited from UDAF

### Inherited from Serializable

### Inherited from AnyRef

### Inherited from Any

### Ungrouped