org.apache.spark.sql.connector.write

Interface WriteBuilder

All Known Subinterfaces:

DeltaWriteBuilder, SupportsDynamicOverwrite, SupportsOverwrite, SupportsOverwriteV2, SupportsTruncate

@Evolving
public interface WriteBuilder

An interface for building the Write. Implementations can mix in some interfaces to support different ways to write data to data sources.

Unless modified by a mixin interface, the Write 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 Write	build() Returns a logical Write shared between batch and streaming.
default BatchWrite	buildForBatch() Deprecated. use build() instead.
default StreamingWrite	buildForStreaming() Deprecated. use build() instead.

Method Detail

build

default Write build()

Returns a logical Write shared between batch and streaming.

Since:

3.2.0

buildForBatch

@Deprecated
default BatchWrite buildForBatch()

Deprecated. use build() instead.

Returns a BatchWrite to write data to batch source.

buildForStreaming

@Deprecated
default StreamingWrite buildForStreaming()

Deprecated. use build() instead.

Returns a StreamingWrite to write data to streaming source.