c

org.apache.spark.sql.connect

DataStreamWriter

final class DataStreamWriter[T] extends streaming.DataStreamWriter[T]

Interface used to write a streaming Dataset to external storage systems (e.g. file systems, key-value stores, etc). Use Dataset.writeStream to access this.

Annotations
@Evolving()
Since

3.5.0

Linear Supertypes
streaming.DataStreamWriter[T], WriteConfigMethods[streaming.DataStreamWriter[T]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DataStreamWriter
  2. DataStreamWriter
  3. WriteConfigMethods
  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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. def clusterBy(colNames: String*): DataStreamWriter.this.type

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    DataStreamWriter → DataStreamWriter
    Annotations
    @varargs()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def foreach(writer: ForeachWriter[T]): DataStreamWriter.this.type

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    DataStreamWriter → DataStreamWriter
  10. def foreachBatch(function: VoidFunction2[sql.Dataset[T], Long]): DataStreamWriter.this.type

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    DataStreamWriter → DataStreamWriter
    Annotations
    @Evolving()
  11. def foreachBatch(function: (sql.Dataset[T], Long) => Unit): DataStreamWriter.this.type

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    DataStreamWriter → DataStreamWriter
    Annotations
    @Evolving()
  12. def format(source: String): DataStreamWriter.this.type

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    DataStreamWriter → DataStreamWriter
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  19. def option(key: String, value: Double): DataStreamWriter.this.type

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    DataStreamWriter → DataStreamWriter → WriteConfigMethods
  20. def option(key: String, value: Long): DataStreamWriter.this.type

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    DataStreamWriter → DataStreamWriter → WriteConfigMethods
  21. def option(key: String, value: Boolean): DataStreamWriter.this.type

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    DataStreamWriter → DataStreamWriter → WriteConfigMethods
  22. def option(key: String, value: String): DataStreamWriter.this.type

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    DataStreamWriter → WriteConfigMethods
  23. def options(options: Map[String, String]): DataStreamWriter.this.type

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    DataStreamWriter → WriteConfigMethods
  24. def options(options: Map[String, String]): DataStreamWriter.this.type

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    DataStreamWriter → WriteConfigMethods
  25. def outputMode(outputMode: String): DataStreamWriter.this.type

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    DataStreamWriter → DataStreamWriter
  26. def outputMode(outputMode: OutputMode): DataStreamWriter.this.type

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    DataStreamWriter → DataStreamWriter
  27. def partitionBy(colNames: String*): DataStreamWriter.this.type

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    DataStreamWriter → DataStreamWriter
    Annotations
    @varargs()
  28. def queryName(queryName: String): DataStreamWriter.this.type

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    DataStreamWriter → DataStreamWriter
  29. def start(): StreamingQuery

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    DataStreamWriter → DataStreamWriter
    Annotations
    @throws(scala.this.throws.<init>$default$1[java.util.concurrent.TimeoutException])
  30. def start(path: String): StreamingQuery

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    DataStreamWriter → DataStreamWriter
  31. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  32. def toString(): String
    Definition Classes
    AnyRef → Any
  33. def toTable(tableName: String): StreamingQuery

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    DataStreamWriter → DataStreamWriter
    Annotations
    @Evolving() @throws(scala.this.throws.<init>$default$1[java.util.concurrent.TimeoutException])
  34. def trigger(trigger: Trigger): DataStreamWriter.this.type

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Definition Classes
    DataStreamWriter → DataStreamWriter
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  37. 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 streaming.DataStreamWriter[T]

Inherited from WriteConfigMethods[streaming.DataStreamWriter[T]]

Inherited from AnyRef

Inherited from Any

Ungrouped