Packages

t

org.apache.spark.sql.connector.write

SupportsOverwriteV2

trait SupportsOverwriteV2 extends WriteBuilder with SupportsTruncate

Write builder trait for tables that support overwrite by filter.

Overwriting data by filter will delete any data that matches the filter and replace it with data that is committed in the write.

Annotations
@Evolving()
Source
SupportsOverwriteV2.java
Since

3.4.0

Linear Supertypes
SupportsTruncate, WriteBuilder, AnyRef, Any
Known Subclasses
SupportsOverwrite
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SupportsOverwriteV2
  2. SupportsTruncate
  3. WriteBuilder
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def overwrite(predicates: Array[Predicate]): WriteBuilder

    Configures a write to replace data matching the filters with data committed in the write.

    Configures a write to replace data matching the filters with data committed in the write.

    Rows must be deleted from the data source if and only if all of the filters match. That is, filters must be interpreted as ANDed together.

    predicates

    filters used to match data to overwrite

    returns

    this write builder for method chaining

Concrete Value Members

  1. def build(): Write

    Returns a logical Write shared between batch and streaming.

    Returns a logical Write shared between batch and streaming.

    Definition Classes
    WriteBuilder
    Since

    3.2.0

  2. def canOverwrite(predicates: Array[Predicate]): Boolean

    Checks whether it is possible to overwrite data from a data source table that matches filter expressions.

    Checks whether it is possible to overwrite data from a data source table that matches filter expressions.

    Rows should be overwritten from the data source iff all of the filter expressions match. That is, the expressions must be interpreted as a set of filters that are ANDed together.

    predicates

    V2 filter expressions, used to match data to overwrite

    returns

    true if the delete operation can be performed

    Since

    3.4.0

  3. def truncate(): WriteBuilder

    Configures a write to replace all existing data with data committed in the write.

    Configures a write to replace all existing data with data committed in the write.

    returns

    this write builder for method chaining

    Definition Classes
    SupportsOverwriteV2 → SupportsTruncate
    Annotations
    @Override()

Deprecated Value Members

  1. def buildForBatch(): BatchWrite

    Returns a BatchWrite to write data to batch source.

    Returns a BatchWrite to write data to batch source.

    Definition Classes
    WriteBuilder
    Annotations
    @Deprecated
    Deprecated

    (Since version 3.2.0)

  2. def buildForStreaming(): StreamingWrite

    Returns a StreamingWrite to write data to streaming source.

    Returns a StreamingWrite to write data to streaming source.

    Definition Classes
    WriteBuilder
    Annotations
    @Deprecated
    Deprecated

    (Since version 3.2.0)