ReplaceTableTransactionBuilder

All Known Implementing Classes:: ReplaceTableTransactionBuilderV2Impl

@Evolving public interface ReplaceTableTransactionBuilder

Builds a Transaction to replace an existing Delta table.

Replace table creates a new table definition (schema, properties, layout) and atomically replaces the existing table.

Since:: 3.4.0

Method Summary

Modifier and Type

Method

Description

Transaction

build(Engine engine)

Build the transaction for replacing the Delta table.

ReplaceTableTransactionBuilder

withDataLayoutSpec(DataLayoutSpec spec)

Set the data layout specification for the new table definition.

ReplaceTableTransactionBuilder

withMaxRetries(int maxRetries)

Set the maximum number of retries to retry the commit in the case of a retryable error.

ReplaceTableTransactionBuilder

withTableProperties(Map<String,String> properties)

Set table properties for the new table definition.

Method Details
- withTableProperties
  
  ReplaceTableTransactionBuilder withTableProperties(Map<String,String> properties)
  
  Set table properties for the new table definition.
  
  Parameters:
  
  properties - A map of table property names to their values.
- withDataLayoutSpec
  
  ReplaceTableTransactionBuilder withDataLayoutSpec(DataLayoutSpec spec)
  
  Set the data layout specification for the new table definition.
  Parameters:
  
  spec - The data layout specification.
  
  See Also:
  
  DataLayoutSpec
- withMaxRetries
  
  ReplaceTableTransactionBuilder withMaxRetries(int maxRetries)
  
  Set the maximum number of retries to retry the commit in the case of a retryable error.
  
  Parameters:
  
  maxRetries - The maximum number of retries. Must be at least 0. Default is 200.
- build
  
  Transaction build(Engine engine)
  
  Build the transaction for replacing the Delta table.
  The transaction must be committed using Transaction.commit(Engine, io.delta.kernel.utils.CloseableIterable) to apply the changes.
  
  Parameters:
  
  engine - The Engine instance to use for the transaction. Cannot be null.
  
  Returns:
  
  A configured Transaction for replacing the table.