io.delta.kernel.internal

Class TransactionBuilderImpl

Object

io.delta.kernel.internal.TransactionBuilderImpl

All Implemented Interfaces:

TransactionBuilder

public class TransactionBuilderImpl
extends Object
implements TransactionBuilder

Constructor Summary

Constructors

Constructor and Description
TransactionBuilderImpl(TableImpl table, String engineInfo, Operation operation)

Method Summary

Modifier and Type	Method and Description
Transaction	build(Engine engine) Build the transaction.
TransactionBuilder	withPartitionColumns(Engine engine, java.util.List<String> partitionColumns) Set the list of partitions columns when create a new partitioned table.
TransactionBuilder	withSchema(Engine engine, StructType newSchema) Set the schema of the table when creating a new table.
TransactionBuilder	withTableProperties(Engine engine, java.util.Map<String,String> properties) Set the table properties for the table.
TransactionBuilder	withTransactionId(Engine engine, String applicationId, long transactionVersion) Set the transaction identifier for idempotent writes.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TransactionBuilderImpl

public TransactionBuilderImpl(TableImpl table,
                              String engineInfo,
                              Operation operation)

Method Detail

withSchema

public TransactionBuilder withSchema(Engine engine,
                                     StructType newSchema)

Description copied from interface: TransactionBuilder

Set the schema of the table when creating a new table.

Specified by:

withSchema in interface TransactionBuilder

Parameters:

engine - Engine instance to use.

newSchema - The new schema of the table.

Returns:

updated TransactionBuilder instance.

withPartitionColumns

public TransactionBuilder withPartitionColumns(Engine engine,
                                               java.util.List<String> partitionColumns)

Description copied from interface: TransactionBuilder

Set the list of partitions columns when create a new partitioned table.

Specified by:

withPartitionColumns in interface TransactionBuilder

Parameters:

engine - Engine instance to use.

partitionColumns - The partition columns of the table. These should be a subset of the columns in the schema.

Returns:

updated TransactionBuilder instance.

withTransactionId

public TransactionBuilder withTransactionId(Engine engine,
                                            String applicationId,
                                            long transactionVersion)

Description copied from interface: TransactionBuilder

Set the transaction identifier for idempotent writes. Incremental processing systems (e.g., streaming systems) that track progress using their own application-specific versions need to record what progress has been made, in order to avoid duplicating data in the face of failures and retries during writes. By setting the transaction identifier, the Delta table can ensure that the data with same identifier is not written multiple times. For more information refer to the Delta protocol section Transaction Identifiers.

Specified by:

withTransactionId in interface TransactionBuilder

Parameters:

engine - Engine instance to use.

applicationId - The application ID that is writing to the table.

transactionVersion - The version of the transaction. This should be monotonically increasing with each write for the same application ID.

Returns:

updated TransactionBuilder instance.

withTableProperties

public TransactionBuilder withTableProperties(Engine engine,
                                              java.util.Map<String,String> properties)

Description copied from interface: TransactionBuilder

Set the table properties for the table. When the table already contains the property with same key, it gets replaced if it doesn't have the same value.

Specified by:

withTableProperties in interface TransactionBuilder

Parameters:

engine - Engine instance to use.

properties - The table properties to set. These are key-value pairs that can be used to configure the table. And these properties are stored in the table metadata.

Returns:

updated TransactionBuilder instance.

build

public Transaction build(Engine engine)

Description copied from interface: TransactionBuilder

Build the transaction. Also validates the given info to ensure that a valid transaction can be created.

Specified by:

build in interface TransactionBuilder

Parameters:

engine - Engine instance to use.