org.apache.spark.sql.connector.write

Interface WriteBuilder

All Known Subinterfaces:

SupportsDynamicOverwrite, SupportsOverwrite, SupportsTruncate, V1WriteBuilder

@Evolving
public interface WriteBuilder

An interface for building the BatchWrite. Implementations can mix in some interfaces to support different ways to write data to data sources. Unless modified by a mixin interface, the BatchWrite configured by this builder is to append data without affecting existing data.

Since:

3.0.0

Method Summary

Modifier and Type	Method and Description
default BatchWrite	buildForBatch() Returns a BatchWrite to write data to batch source.
default StreamingWrite	buildForStreaming() Returns a StreamingWrite to write data to streaming source.

Method Detail

buildForBatch

default BatchWrite buildForBatch()

Returns a BatchWrite to write data to batch source. By default this method throws exception, data sources must overwrite this method to provide an implementation, if the Table that creates this write returns TableCapability.BATCH_WRITE support in its Table.capabilities().

buildForStreaming

default StreamingWrite buildForStreaming()

Returns a StreamingWrite to write data to streaming source. By default this method throws exception, data sources must overwrite this method to provide an implementation, if the Table that creates this write returns TableCapability.STREAMING_WRITE support in its Table.capabilities().