org.apache.spark.sql.connector.write

Interface SupportsOverwrite

All Superinterfaces:

SupportsTruncate, WriteBuilder

@Evolving
public interface SupportsOverwrite
extends WriteBuilder, 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.

Since:

3.0.0

Method Summary

Modifier and Type	Method and Description
WriteBuilder	overwrite(Filter[] filters) Configures a write to replace data matching the filters with data committed in the write.
default WriteBuilder	truncate() Configures a write to replace all existing data with data committed in the write.

Methods inherited from interface org.apache.spark.sql.connector.write.WriteBuilder

buildForBatch, buildForStreaming

Method Detail

overwrite

WriteBuilder overwrite(Filter[] filters)

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.

Parameters:

filters - filters used to match data to overwrite

Returns:

this write builder for method chaining

truncate

default WriteBuilder truncate()

Description copied from interface: SupportsTruncate

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

Specified by:

truncate in interface SupportsTruncate

Returns:

this write builder for method chaining