org.apache.spark.sql.connector.write

Interface V1WriteBuilder

All Superinterfaces:

WriteBuilder

public interface V1WriteBuilder
extends WriteBuilder

A trait that should be implemented by V1 DataSources that would like to leverage the DataSource V2 write code paths. The InsertableRelation will be used only to Append data. Other instances of the WriteBuilder interface such as SupportsOverwrite, SupportsTruncate should be extended as well to support additional operations other than data appends.

This interface is designed to provide Spark DataSources time to migrate to DataSource V2 and will be removed in a future Spark release.

Since:

3.0.0

Method Summary

Modifier and Type	Method and Description
BatchWrite	buildForBatch() Returns a BatchWrite to write data to batch source.
StreamingWrite	buildForStreaming() Returns a StreamingWrite to write data to streaming source.
InsertableRelation	buildForV1Write() Creates an InsertableRelation that allows appending a DataFrame to a a destination (using data source-specific parameters).

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

withInputDataSchema, withQueryId

Method Detail

buildForBatch

BatchWrite buildForBatch()

Description copied from interface: WriteBuilder

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().

Specified by:

buildForBatch in interface WriteBuilder

buildForStreaming

StreamingWrite buildForStreaming()

Description copied from interface: WriteBuilder

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().

Specified by:

buildForStreaming in interface WriteBuilder

buildForV1Write

InsertableRelation buildForV1Write()

Creates an InsertableRelation that allows appending a DataFrame to a a destination (using data source-specific parameters). The insert method will only be called with overwrite=false. The DataSource should implement the overwrite behavior as part of the SupportsOverwrite, and SupportsTruncate interfaces.

Returns:

(undocumented)

Since:

3.0.0