Packages

trait DeltaBatchWrite extends BatchWrite

Experimental

An interface that defines how to write a delta of rows during batch processing.

Annotations
@Experimental()
Source
DeltaBatchWrite.java
Since

3.4.0

Linear Supertypes
BatchWrite, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DeltaBatchWrite
  2. BatchWrite
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def abort(messages: Array[WriterCommitMessage]): Unit

    Aborts this writing job because some data writers are failed and keep failing when retry, or the Spark job fails with some unknown reasons, or #onDataWriterCommit(WriterCommitMessage) fails, or #commit(WriterCommitMessage[]) fails.

    Aborts this writing job because some data writers are failed and keep failing when retry, or the Spark job fails with some unknown reasons, or #onDataWriterCommit(WriterCommitMessage) fails, or #commit(WriterCommitMessage[]) fails.

    If this method fails (by throwing an exception), the underlying data source may require manual cleanup.

    Unless the abort is triggered by the failure of commit, the given messages should have some null slots as there maybe only a few data writers that are committed before the abort happens, or some data writers were committed but their commit messages haven't reached the driver when the abort is triggered. So this is just a "best effort" for data sources to clean up the data left by data writers.

    Definition Classes
    BatchWrite
  2. abstract def commit(messages: Array[WriterCommitMessage]): Unit

    Commits this writing job with a list of commit messages.

    Commits this writing job with a list of commit messages. The commit messages are collected from successful data writers and are produced by DataWriter#commit().

    If this method fails (by throwing an exception), this writing job is considered to to have been failed, and #abort(WriterCommitMessage[]) would be called. The state of the destination is undefined and @#abort(WriterCommitMessage[]) may not be able to deal with it.

    Note that speculative execution may cause multiple tasks to run for a partition. By default, Spark uses the commit coordinator to allow at most one task to commit. Implementations can disable this behavior by overriding #useCommitCoordinator(). If disabled, multiple tasks may have committed successfully and one successful commit message per task will be passed to this commit method. The remaining commit messages are ignored by Spark.

    Definition Classes
    BatchWrite
  3. abstract def createBatchWriterFactory(info: PhysicalWriteInfo): DeltaWriterFactory

    Creates a writer factory which will be serialized and sent to executors.

    Creates a writer factory which will be serialized and sent to executors.

    If this method fails (by throwing an exception), the action will fail and no Spark job will be submitted.

    info

    Physical information about the input data that will be written to this table.

    Definition Classes
    DeltaBatchWriteBatchWrite
    Annotations
    @Override()

Concrete Value Members

  1. def onDataWriterCommit(message: WriterCommitMessage): Unit

    Handles a commit message on receiving from a successful data writer.

    Handles a commit message on receiving from a successful data writer.

    If this method fails (by throwing an exception), this writing job is considered to to have been failed, and #abort(WriterCommitMessage[]) would be called.

    Definition Classes
    BatchWrite
  2. def useCommitCoordinator(): Boolean

    Returns whether Spark should use the commit coordinator to ensure that at most one task for each partition commits.

    Returns whether Spark should use the commit coordinator to ensure that at most one task for each partition commits.

    returns

    true if commit coordinator should be used, false otherwise.

    Definition Classes
    BatchWrite