Packages

trait Write extends AnyRef

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

Annotations
@Evolving()
Source
Write.java
Since

3.2.0

Linear Supertypes
AnyRef, Any
Known Subclasses
DeltaWrite, RequiresDistributionAndOrdering, V1Write
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Write
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. def description(): String

    Returns the description associated with this write.

  2. def supportedCustomMetrics(): Array[CustomMetric]

    Returns an array of supported custom metrics with name and description.

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

  3. def toBatch(): BatchWrite

    Returns a BatchWrite to write data to batch source.

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

  4. def toStreaming(): StreamingWrite

    Returns a StreamingWrite to write data to streaming source.

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