Package org.apache.iceberg.actions

Interface MigrateTable

All Superinterfaces:

Action<MigrateTable,MigrateTable.Result>

All Known Implementing Classes:

MigrateTableSparkAction

public interface MigrateTable
extends Action<MigrateTable,MigrateTable.Result>

An action that migrates an existing table to Iceberg.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MigrateTable.Result	The action result that contains a summary of the execution.

Method Summary

Modifier and Type	Method	Description
default MigrateTable	backupTableName(String tableName)	Sets a table name for the backup of the original table.
default MigrateTable	dropBackup()	Drops the backup of the original table after a successful migration
default MigrateTable	executeWith(ExecutorService service)	Sets the executor service to use for parallel file reading.
MigrateTable	tableProperties(Map<String,String> properties)	Sets table properties in the newly created Iceberg table.
MigrateTable	tableProperty(String name, String value)	Sets a table property in the newly created Iceberg table.

Methods inherited from interface org.apache.iceberg.actions.Action

execute, option, options

Method Details

tableProperties

MigrateTable tableProperties(Map<String,String> properties)

Sets table properties in the newly created Iceberg table. Any properties with the same key name will be overwritten.

Parameters:

properties - a map of properties to set

Returns:

this for method chaining

tableProperty

MigrateTable tableProperty(String name,
 String value)

Sets a table property in the newly created Iceberg table. Any properties with the same key will be overwritten.

Parameters:

name - a table property name

value - a table property value

Returns:

this for method chaining

dropBackup

default MigrateTable dropBackup()

Drops the backup of the original table after a successful migration

Returns:

this for method chaining

backupTableName

default MigrateTable backupTableName(String tableName)

Sets a table name for the backup of the original table.

Parameters:

tableName - the table name for backup

Returns:

this for method chaining

executeWith

default MigrateTable executeWith(ExecutorService service)

Sets the executor service to use for parallel file reading. The default is not using executor service.

Parameters:

service - executor service

Returns:

this for method chaining