c

org.apache.spark.sql.connect

KeyValueGroupedDataset

class KeyValueGroupedDataset[K, V] extends sql.KeyValueGroupedDataset[K, V]

A Dataset has been logically grouped by a user specified grouping key. Users should not construct a KeyValueGroupedDataset directly, but should instead call groupByKey on an existing Dataset.

Since

3.5.0

Linear Supertypes
sql.KeyValueGroupedDataset[K, V], Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. KeyValueGroupedDataset
  2. KeyValueGroupedDataset
  3. Serializable
  4. AnyRef
  5. 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. def agg[U1, U2, U3, U4, U5, U6, U7, U8](col1: TypedColumn[V, U1], col2: TypedColumn[V, U2], col3: TypedColumn[V, U3], col4: TypedColumn[V, U4], col5: TypedColumn[V, U5], col6: TypedColumn[V, U6], col7: TypedColumn[V, U7], col8: TypedColumn[V, U8]): Dataset[(K, U1, U2, U3, U4, U5, U6, U7, U8)]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  5. def agg[U1, U2, U3, U4, U5, U6, U7](col1: TypedColumn[V, U1], col2: TypedColumn[V, U2], col3: TypedColumn[V, U3], col4: TypedColumn[V, U4], col5: TypedColumn[V, U5], col6: TypedColumn[V, U6], col7: TypedColumn[V, U7]): Dataset[(K, U1, U2, U3, U4, U5, U6, U7)]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  6. def agg[U1, U2, U3, U4, U5, U6](col1: TypedColumn[V, U1], col2: TypedColumn[V, U2], col3: TypedColumn[V, U3], col4: TypedColumn[V, U4], col5: TypedColumn[V, U5], col6: TypedColumn[V, U6]): Dataset[(K, U1, U2, U3, U4, U5, U6)]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  7. def agg[U1, U2, U3, U4, U5](col1: TypedColumn[V, U1], col2: TypedColumn[V, U2], col3: TypedColumn[V, U3], col4: TypedColumn[V, U4], col5: TypedColumn[V, U5]): Dataset[(K, U1, U2, U3, U4, U5)]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  8. def agg[U1, U2, U3, U4](col1: TypedColumn[V, U1], col2: TypedColumn[V, U2], col3: TypedColumn[V, U3], col4: TypedColumn[V, U4]): Dataset[(K, U1, U2, U3, U4)]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  9. def agg[U1, U2, U3](col1: TypedColumn[V, U1], col2: TypedColumn[V, U2], col3: TypedColumn[V, U3]): Dataset[(K, U1, U2, U3)]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  10. def agg[U1, U2](col1: TypedColumn[V, U1], col2: TypedColumn[V, U2]): Dataset[(K, U1, U2)]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  11. def agg[U1](col1: TypedColumn[V, U1]): Dataset[(K, U1)]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  12. def aggUntyped(columns: TypedColumn[_, _]*): Dataset[_]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Attributes
    protected
    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  15. def cogroup[U, R](other: sql.KeyValueGroupedDataset[K, U], f: CoGroupFunction[K, V, U, R], encoder: Encoder[R]): Dataset[R]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  16. def cogroup[U, R](other: sql.KeyValueGroupedDataset[K, U])(f: (K, Iterator[V], Iterator[U]) => IterableOnce[R])(implicit arg0: Encoder[R]): Dataset[R]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  17. def cogroupSorted[U, R](other: sql.KeyValueGroupedDataset[K, U], thisSortExprs: Array[Column], otherSortExprs: Array[Column], f: CoGroupFunction[K, V, U, R], encoder: Encoder[R]): Dataset[R]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  18. def cogroupSorted[U, R](other: sql.KeyValueGroupedDataset[K, U])(thisSortExprs: Column*)(otherSortExprs: Column*)(f: (K, Iterator[V], Iterator[U]) => IterableOnce[R])(implicit arg0: Encoder[R]): Dataset[R]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  19. def count(): Dataset[(K, Long)]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  22. def flatMapGroups[U](f: FlatMapGroupsFunction[K, V, U], encoder: Encoder[U]): Dataset[U]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  23. def flatMapGroups[U](f: (K, Iterator[V]) => IterableOnce[U])(implicit arg0: Encoder[U]): Dataset[U]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  24. def flatMapGroupsWithState[S, U](func: FlatMapGroupsWithStateFunction[K, V, S, U], outputMode: OutputMode, stateEncoder: Encoder[S], outputEncoder: Encoder[U], timeoutConf: GroupStateTimeout, initialState: sql.KeyValueGroupedDataset[K, S]): Dataset[U]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  25. def flatMapGroupsWithState[S, U](func: FlatMapGroupsWithStateFunction[K, V, S, U], outputMode: OutputMode, stateEncoder: Encoder[S], outputEncoder: Encoder[U], timeoutConf: GroupStateTimeout): Dataset[U]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  26. def flatMapGroupsWithState[S, U](outputMode: OutputMode, timeoutConf: GroupStateTimeout, initialState: sql.KeyValueGroupedDataset[K, S])(func: (K, Iterator[V], GroupState[S]) => Iterator[U])(implicit arg0: Encoder[S], arg1: Encoder[U]): Dataset[U]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  27. def flatMapGroupsWithState[S, U](outputMode: OutputMode, timeoutConf: GroupStateTimeout)(func: (K, Iterator[V], GroupState[S]) => Iterator[U])(implicit arg0: Encoder[S], arg1: Encoder[U]): Dataset[U]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  28. def flatMapGroupsWithStateHelper[S, U](outputMode: Option[OutputMode], timeoutConf: GroupStateTimeout, initialState: Option[KeyValueGroupedDataset[K, S]], isMapGroupWithState: Boolean)(func: (K, Iterator[V], GroupState[S]) => Iterator[U])(implicit arg0: Encoder[S], arg1: Encoder[U]): Dataset[U]
    Attributes
    protected[sql]
  29. def flatMapSortedGroups[U](SortExprs: Array[Column], f: FlatMapGroupsFunction[K, V, U], encoder: Encoder[U]): Dataset[U]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  30. def flatMapSortedGroups[U](sortExprs: Column*)(f: (K, Iterator[V]) => IterableOnce[U])(implicit arg0: Encoder[U]): Dataset[U]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  31. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  32. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  33. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  34. def keyAs[L](implicit arg0: Encoder[L]): KeyValueGroupedDataset[L, V]

    Returns a new KeyValueGroupedDataset where the type of the key has been mapped to the specified type.

    Returns a new KeyValueGroupedDataset where the type of the key has been mapped to the specified type. The mapping of key columns to the type follows the same rules as as on Dataset.

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
    Since

    3.5.0

  35. def keys: Dataset[K]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  36. def mapGroups[U](f: MapGroupsFunction[K, V, U], encoder: Encoder[U]): Dataset[U]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  37. def mapGroups[U](f: (K, Iterator[V]) => U)(implicit arg0: Encoder[U]): Dataset[U]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  38. def mapGroupsWithState[S, U](func: MapGroupsWithStateFunction[K, V, S, U], stateEncoder: Encoder[S], outputEncoder: Encoder[U], timeoutConf: GroupStateTimeout, initialState: sql.KeyValueGroupedDataset[K, S]): Dataset[U]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  39. def mapGroupsWithState[S, U](func: MapGroupsWithStateFunction[K, V, S, U], stateEncoder: Encoder[S], outputEncoder: Encoder[U], timeoutConf: GroupStateTimeout): Dataset[U]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  40. def mapGroupsWithState[S, U](func: MapGroupsWithStateFunction[K, V, S, U], stateEncoder: Encoder[S], outputEncoder: Encoder[U]): Dataset[U]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  41. def mapGroupsWithState[S, U](timeoutConf: GroupStateTimeout, initialState: sql.KeyValueGroupedDataset[K, S])(func: (K, Iterator[V], GroupState[S]) => U)(implicit arg0: Encoder[S], arg1: Encoder[U]): Dataset[U]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  42. def mapGroupsWithState[S, U](timeoutConf: GroupStateTimeout)(func: (K, Iterator[V], GroupState[S]) => U)(implicit arg0: Encoder[S], arg1: Encoder[U]): Dataset[U]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  43. def mapGroupsWithState[S, U](func: (K, Iterator[V], GroupState[S]) => U)(implicit arg0: Encoder[S], arg1: Encoder[U]): Dataset[U]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  44. def mapValues[W](func: MapFunction[V, W], encoder: Encoder[W]): KeyValueGroupedDataset[K, W]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  45. def mapValues[W](valueFunc: (V) => W)(implicit arg0: Encoder[W]): KeyValueGroupedDataset[K, W]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  46. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  47. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  48. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  49. def reduceGroups(f: ReduceFunction[V]): Dataset[(K, V)]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  50. def reduceGroups(f: (V, V) => V): Dataset[(K, V)]

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    KeyValueGroupedDataset → KeyValueGroupedDataset
  51. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  52. def toString(): String
    Definition Classes
    AnyRef → Any
  53. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  54. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  55. 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 sql.KeyValueGroupedDataset[K, V]

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped