Snowpark Scala API Reference1.19.1 < Back


# Packages

-  package root
  Definition Classes
    root
-  package com
  Definition Classes
    root
-  package snowflake
  Definition Classes
    com
-  package snowpark
  Definition Classes
    snowflake
-  package udtf
  Definition Classes
    snowpark
- UDTF
- UDTF0
- UDTF1
- UDTF10
- UDTF11
- UDTF12
- UDTF13
- UDTF14
- UDTF15
- UDTF16
- UDTF17
- UDTF18
- UDTF19
- UDTF2
- UDTF20
- UDTF21
- UDTF22
- UDTF3
- UDTF4
- UDTF5
- UDTF6
- UDTF7
- UDTF8
- UDTF9

c

com.snowflake.snowpark.udtf

# UDTF5

###

#### abstract class UDTF5[A0, A1, A2, A3, A4] extends UDTF

The Scala UDTF (user-defined table function) abstract class that has 5 arguments.

Since

  1.2.0

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

1. Alphabetic
2. By Inheritance

Inherited

1. UDTF5
2. UDTF
3. Serializable
4. AnyRef
5. Any

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Instance Constructors

1.  new UDTF5()(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[A0], arg1: scala.reflect.api.JavaUniverse.TypeTag[A1], arg2: scala.reflect.api.JavaUniverse.TypeTag[A2], arg3: scala.reflect.api.JavaUniverse.TypeTag[A3], arg4: scala.reflect.api.JavaUniverse.TypeTag[A4])

### Abstract Value Members

1.  abstract def endPartition(): Iterable[Row]

   This method can be used to generate output rows that are based on any state information aggregated in process().

   This method can be used to generate output rows that are based on any state information aggregated in process(). This method is invoked once for each partition, after all rows in that partition have been passed to process().

   The rows returned in this method must match the StructType defined in outputSchema

   Since: 1.2.0

   Definition Classes
     UDTF
2.  abstract def outputSchema(): StructType

   A StructType that describes the data types of the fields in the rows returned by the process() and endPartition() methods.

   A StructType that describes the data types of the fields in the rows returned by the process() and endPartition() methods.

   For example, if a UDTF returns rows that contain a StringType and IntegerType field, the outputSchema() method should construct and return the following StructType object: {{ override def outputSchema(): StructType = StructType(StructField("word", StringType), StructField("count", IntegerType)) }}

   Since: 1.2.0

   Definition Classes
     UDTF
3.  abstract def process(arg0: A0, arg1: A1, arg2: A2, arg3: A3, arg4: A4): Iterable[Row]

   This method is invoked once for each row in the input partition.

   This method is invoked once for each row in the input partition. The arguments passed to the registered UDTF are passed to process().

   The rows returned in this method must match the StructType defined in outputSchema

   Since: 1.2.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(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
6.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
7.  def equals(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef → Any
8.  final def getClass(): Class[_ <: AnyRef]
   Definition Classes
     AnyRef → Any
   Annotations
     @HotSpotIntrinsicCandidate() @native()
9.  def hashCode(): Int
   Definition Classes
     AnyRef → Any
   Annotations
     @HotSpotIntrinsicCandidate() @native()
10.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
11.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
12.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @HotSpotIntrinsicCandidate() @native()
13.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @HotSpotIntrinsicCandidate() @native()
14.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
15.  def toString(): String
    Definition Classes
      AnyRef → Any
16.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
17.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()
18.  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 UDTF

### Inherited from Serializable

### Inherited from AnyRef

### Inherited from Any

### Ungrouped