org.apache.spark.sql.connector.write

Interface Write

All Known Subinterfaces:

DeltaWrite, RequiresDistributionAndOrdering, V1Write

@Evolving
public interface Write

A logical representation of a data source write.

This logical representation is shared between batch and streaming write. Data sources must implement the corresponding methods in this interface to match what the table promises to support. For example, toBatch() must be implemented if the Table that creates this Write returns TableCapability.BATCH_WRITE support in its Table.capabilities().

Since:

3.2.0

Method Summary

Modifier and Type	Method and Description
default String	description() Returns the description associated with this write.
default CustomMetric[]	supportedCustomMetrics() Returns an array of supported custom metrics with name and description.
default BatchWrite	toBatch() Returns a BatchWrite to write data to batch source.
default StreamingWrite	toStreaming() Returns a StreamingWrite to write data to streaming source.

Method Detail

description

default String description()

Returns the description associated with this write.

toBatch

default BatchWrite toBatch()

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

toStreaming

default StreamingWrite toStreaming()

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

supportedCustomMetrics

default CustomMetric[] supportedCustomMetrics()

Returns an array of supported custom metrics with name and description. By default it returns empty array.