Package io.delta.kernel.internal

Class CreateTableTransactionBuilderImpl

Object

io.delta.kernel.internal.CreateTableTransactionBuilderImpl

All Implemented Interfaces:

CreateTableTransactionBuilder

public class CreateTableTransactionBuilderImpl
extends Object
implements CreateTableTransactionBuilder

Constructor Summary

Constructors

Constructor	Description
CreateTableTransactionBuilderImpl(String tablePath, StructType schema, String engineInfo)

Method Summary

Modifier and Type	Method	Description
Transaction	build(Engine engine)	Build the transaction for creating the Delta table.
Optional<Committer>	getCommitterOpt()
Optional<Map<String,String>>	getTablePropertiesOpt()
CreateTableTransactionBuilder	withClock(Clock clock)
CreateTableTransactionBuilder	withCommitter(Committer committer)	Provides a custom committer to use at transaction commit time.
CreateTableTransactionBuilder	withDataLayoutSpec(DataLayoutSpec spec)	Set the data layout specification for the new Delta table.
CreateTableTransactionBuilder	withMaxRetries(int maxRetries)	Set the maximum number of retries to retry the commit in the case of a retryable error.
CreateTableTransactionBuilder	withTableProperties(Map<String,String> properties)	Set table properties for the new Delta table.

Methods inherited from class java.lang.Object

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

Constructor Details

CreateTableTransactionBuilderImpl

public CreateTableTransactionBuilderImpl(String tablePath,
 StructType schema,
 String engineInfo)

Method Details

withTableProperties

public CreateTableTransactionBuilder withTableProperties(Map<String,String> properties)

Description copied from interface: CreateTableTransactionBuilder

Set table properties for the new Delta table.

This method can be called multiple times to add additional properties. If a property key already exists from a previous call with a different value, an IllegalArgumentException will be thrown.

Note, user-properties (those without a '.delta' prefix) are case-sensitive. Delta-properties are case-insensitive and are normalized to their expected case before writing to the log.

Specified by:

withTableProperties in interface CreateTableTransactionBuilder

Parameters:

properties - A map of table property names to their values.

withDataLayoutSpec

public CreateTableTransactionBuilder withDataLayoutSpec(DataLayoutSpec spec)

Description copied from interface: CreateTableTransactionBuilder

Set the data layout specification for the new Delta table.

The data layout specification determines how data files are organized within the table, such as partitioning and clustering strategies.

The default, if not specified in the builder, is unpartitioned.

Specified by:

withDataLayoutSpec in interface CreateTableTransactionBuilder

Parameters:

spec - The data layout specification.

See Also:

• DataLayoutSpec

withMaxRetries

public CreateTableTransactionBuilder withMaxRetries(int maxRetries)

Description copied from interface: CreateTableTransactionBuilder

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

Specified by:

withMaxRetries in interface CreateTableTransactionBuilder

Parameters:

maxRetries - The maximum number of retries. Must be at least 0. Default is 200.

withCommitter

public CreateTableTransactionBuilder withCommitter(Committer committer)

Description copied from interface: CreateTableTransactionBuilder

Provides a custom committer to use at transaction commit time.

Catalog implementations that wish to support the catalogManaged Delta table feature should provide to engines their own catalog-specific Committer implementation which may, for example, send a commit RPC to the catalog service to finalize the commit.

If no committer is provided, a default committer will be created that only supports writing into filesystem-managed Delta tables.

Specified by:

withCommitter in interface CreateTableTransactionBuilder

Parameters:

committer - the committer to use

Returns:

a new builder instance with the provided committer

See Also:

• Committer

withClock

@VisibleForTesting
public CreateTableTransactionBuilder withClock(Clock clock)

build

public Transaction build(Engine engine)

Description copied from interface: CreateTableTransactionBuilder

Build the transaction for creating the Delta table.

This validates all the configuration and creates a Transaction that can be used to create the new Delta table. The transaction must be committed using Transaction.commit(Engine, CloseableIterable) to actually create the table.

Specified by:

build in interface CreateTableTransactionBuilder

Parameters:

engine - The Engine instance to use.

Returns:

A configured Transaction for creating the table.

getTablePropertiesOpt

@VisibleForTesting
public Optional<Map<String,String>> getTablePropertiesOpt()

getCommitterOpt

@VisibleForTesting
public Optional<Committer> getCommitterOpt()