org.apache.iceberg.spark.actions

Class MigrateTableSparkAction

java.lang.Object

org.apache.iceberg.spark.actions.MigrateTableSparkAction

All Implemented Interfaces:

org.apache.iceberg.actions.Action<org.apache.iceberg.actions.MigrateTable,org.apache.iceberg.actions.MigrateTable.Result>, org.apache.iceberg.actions.MigrateTable

public class MigrateTableSparkAction
extends java.lang.Object
implements org.apache.iceberg.actions.MigrateTable

Takes a Spark table in the source catalog and attempts to transform it into an Iceberg table in the same location with the same identifier. Once complete the identifier which previously referred to a non-Iceberg table will refer to the newly migrated Iceberg table.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.iceberg.actions.MigrateTable

org.apache.iceberg.actions.MigrateTable.Result

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.iceberg.relocated.com.google.common.base.Joiner	COMMA_JOINER
protected static org.apache.iceberg.relocated.com.google.common.base.Splitter	COMMA_SPLITTER
protected static java.util.List<java.lang.String>	EXCLUDED_PROPERTIES
protected static java.lang.String	FILE_PATH
protected static java.lang.String	ICEBERG_METADATA_FOLDER
protected static java.lang.String	LAST_MODIFIED
protected static java.lang.String	LOCATION
protected static java.lang.String	MANIFEST
protected static java.lang.String	MANIFEST_LIST
protected static java.lang.String	OTHERS
protected static java.lang.String	STATISTICS_FILES

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.String>	additionalProperties()
protected org.apache.spark.sql.Dataset<FileInfo>	allReachableOtherMetadataFileDS(org.apache.iceberg.Table table)
MigrateTableSparkAction	backupTableName(java.lang.String tableName)
protected org.apache.spark.sql.connector.catalog.StagingTableCatalog	checkDestinationCatalog(org.apache.spark.sql.connector.catalog.CatalogPlugin catalog)
protected org.apache.spark.sql.connector.catalog.TableCatalog	checkSourceCatalog(org.apache.spark.sql.connector.catalog.CatalogPlugin catalog)
protected org.apache.spark.sql.Dataset<FileInfo>	contentFileDS(org.apache.iceberg.Table table)
protected org.apache.spark.sql.Dataset<FileInfo>	contentFileDS(org.apache.iceberg.Table table, java.util.Set<java.lang.Long> snapshotIds)
protected org.apache.iceberg.spark.actions.BaseSparkAction.DeleteSummary	deleteFiles(java.util.concurrent.ExecutorService executorService, java.util.function.Consumer<java.lang.String> deleteFunc, java.util.Iterator<FileInfo> files) Deletes files and keeps track of how many files were removed for each file type.
protected org.apache.iceberg.spark.actions.BaseSparkAction.DeleteSummary	deleteFiles(org.apache.iceberg.io.SupportsBulkOperations io, java.util.Iterator<FileInfo> files)
protected org.apache.spark.sql.connector.catalog.StagingTableCatalog	destCatalog()
protected org.apache.spark.sql.connector.catalog.Identifier	destTableIdent()
protected java.util.Map<java.lang.String,java.lang.String>	destTableProps()
MigrateTableSparkAction	dropBackup()
protected void	ensureNameMappingPresent(org.apache.iceberg.Table table)
org.apache.iceberg.actions.MigrateTable.Result	execute()
MigrateTableSparkAction	executeWith(java.util.concurrent.ExecutorService service)
protected java.lang.String	getMetadataLocation(org.apache.iceberg.Table table)
protected org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>	loadMetadataTable(org.apache.iceberg.Table table, org.apache.iceberg.MetadataTableType type)
protected org.apache.spark.sql.Dataset<FileInfo>	manifestDS(org.apache.iceberg.Table table)
protected org.apache.spark.sql.Dataset<FileInfo>	manifestDS(org.apache.iceberg.Table table, java.util.Set<java.lang.Long> snapshotIds)
protected org.apache.spark.sql.Dataset<FileInfo>	manifestListDS(org.apache.iceberg.Table table)
protected org.apache.spark.sql.Dataset<FileInfo>	manifestListDS(org.apache.iceberg.Table table, java.util.Set<java.lang.Long> snapshotIds)
protected JobGroupInfo	newJobGroupInfo(java.lang.String groupId, java.lang.String desc)
protected org.apache.iceberg.Table	newStaticTable(org.apache.iceberg.TableMetadata metadata, org.apache.iceberg.io.FileIO io)
ThisT	option(java.lang.String name, java.lang.String value)
protected java.util.Map<java.lang.String,java.lang.String>	options()
ThisT	options(java.util.Map<java.lang.String,java.lang.String> newOptions)
protected org.apache.spark.sql.Dataset<FileInfo>	otherMetadataFileDS(org.apache.iceberg.Table table)
protected MigrateTableSparkAction	self()
protected void	setProperties(java.util.Map<java.lang.String,java.lang.String> properties)
protected void	setProperty(java.lang.String key, java.lang.String value)
protected org.apache.spark.sql.connector.catalog.TableCatalog	sourceCatalog()
protected org.apache.spark.sql.connector.catalog.Identifier	sourceTableIdent()
protected java.lang.String	sourceTableLocation()
protected org.apache.spark.sql.SparkSession	spark()
protected org.apache.spark.api.java.JavaSparkContext	sparkContext()
protected StagedSparkTable	stageDestTable()
protected org.apache.spark.sql.Dataset<FileInfo>	statisticsFileDS(org.apache.iceberg.Table table, java.util.Set<java.lang.Long> snapshotIds)
MigrateTableSparkAction	tableProperties(java.util.Map<java.lang.String,java.lang.String> properties)
MigrateTableSparkAction	tableProperty(java.lang.String property, java.lang.String value)
protected org.apache.spark.sql.catalyst.catalog.CatalogTable	v1SourceTable()
protected <T> T	withJobGroupInfo(JobGroupInfo info, java.util.function.Supplier<T> supplier)

Methods inherited from class java.lang.Object

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

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

option, options

Field Detail

LOCATION

protected static final java.lang.String LOCATION

See Also:

Constant Field Values

ICEBERG_METADATA_FOLDER

protected static final java.lang.String ICEBERG_METADATA_FOLDER

See Also:

Constant Field Values

EXCLUDED_PROPERTIES

protected static final java.util.List<java.lang.String> EXCLUDED_PROPERTIES

MANIFEST

protected static final java.lang.String MANIFEST

See Also:

Constant Field Values

MANIFEST_LIST

protected static final java.lang.String MANIFEST_LIST

See Also:

Constant Field Values

STATISTICS_FILES

protected static final java.lang.String STATISTICS_FILES

See Also:

Constant Field Values

OTHERS

protected static final java.lang.String OTHERS

See Also:

Constant Field Values

FILE_PATH

protected static final java.lang.String FILE_PATH

See Also:

Constant Field Values

LAST_MODIFIED

protected static final java.lang.String LAST_MODIFIED

See Also:

Constant Field Values

COMMA_SPLITTER

protected static final org.apache.iceberg.relocated.com.google.common.base.Splitter COMMA_SPLITTER

COMMA_JOINER

protected static final org.apache.iceberg.relocated.com.google.common.base.Joiner COMMA_JOINER

Method Detail

self

protected MigrateTableSparkAction self()

destCatalog

protected org.apache.spark.sql.connector.catalog.StagingTableCatalog destCatalog()

destTableIdent

protected org.apache.spark.sql.connector.catalog.Identifier destTableIdent()

tableProperties

public MigrateTableSparkAction tableProperties(java.util.Map<java.lang.String,java.lang.String> properties)

Specified by:

tableProperties in interface org.apache.iceberg.actions.MigrateTable

tableProperty

public MigrateTableSparkAction tableProperty(java.lang.String property,
                                             java.lang.String value)

Specified by:

tableProperty in interface org.apache.iceberg.actions.MigrateTable

dropBackup

public MigrateTableSparkAction dropBackup()

Specified by:

dropBackup in interface org.apache.iceberg.actions.MigrateTable

backupTableName

public MigrateTableSparkAction backupTableName(java.lang.String tableName)

Specified by:

backupTableName in interface org.apache.iceberg.actions.MigrateTable

executeWith

public MigrateTableSparkAction executeWith(java.util.concurrent.ExecutorService service)

Specified by:

executeWith in interface org.apache.iceberg.actions.MigrateTable

execute

public org.apache.iceberg.actions.MigrateTable.Result execute()

Specified by:

execute in interface org.apache.iceberg.actions.Action<org.apache.iceberg.actions.MigrateTable,org.apache.iceberg.actions.MigrateTable.Result>

destTableProps

protected java.util.Map<java.lang.String,java.lang.String> destTableProps()

checkSourceCatalog

protected org.apache.spark.sql.connector.catalog.TableCatalog checkSourceCatalog(org.apache.spark.sql.connector.catalog.CatalogPlugin catalog)

sourceTableLocation

protected java.lang.String sourceTableLocation()

v1SourceTable

protected org.apache.spark.sql.catalyst.catalog.CatalogTable v1SourceTable()

sourceCatalog

protected org.apache.spark.sql.connector.catalog.TableCatalog sourceCatalog()

sourceTableIdent

protected org.apache.spark.sql.connector.catalog.Identifier sourceTableIdent()

setProperties

protected void setProperties(java.util.Map<java.lang.String,java.lang.String> properties)

setProperty

protected void setProperty(java.lang.String key,
                           java.lang.String value)

additionalProperties

protected java.util.Map<java.lang.String,java.lang.String> additionalProperties()

checkDestinationCatalog

protected org.apache.spark.sql.connector.catalog.StagingTableCatalog checkDestinationCatalog(org.apache.spark.sql.connector.catalog.CatalogPlugin catalog)

stageDestTable

protected StagedSparkTable stageDestTable()

ensureNameMappingPresent

protected void ensureNameMappingPresent(org.apache.iceberg.Table table)

getMetadataLocation

protected java.lang.String getMetadataLocation(org.apache.iceberg.Table table)

spark

protected org.apache.spark.sql.SparkSession spark()

sparkContext

protected org.apache.spark.api.java.JavaSparkContext sparkContext()

option

public ThisT option(java.lang.String name,
                    java.lang.String value)

options

public ThisT options(java.util.Map<java.lang.String,java.lang.String> newOptions)

options

protected java.util.Map<java.lang.String,java.lang.String> options()

withJobGroupInfo

protected <T> T withJobGroupInfo(JobGroupInfo info,
                                 java.util.function.Supplier<T> supplier)

newJobGroupInfo

protected JobGroupInfo newJobGroupInfo(java.lang.String groupId,
                                       java.lang.String desc)

newStaticTable

protected org.apache.iceberg.Table newStaticTable(org.apache.iceberg.TableMetadata metadata,
                                                  org.apache.iceberg.io.FileIO io)

contentFileDS

protected org.apache.spark.sql.Dataset<FileInfo> contentFileDS(org.apache.iceberg.Table table)

contentFileDS

protected org.apache.spark.sql.Dataset<FileInfo> contentFileDS(org.apache.iceberg.Table table,
                                                               java.util.Set<java.lang.Long> snapshotIds)

manifestDS

protected org.apache.spark.sql.Dataset<FileInfo> manifestDS(org.apache.iceberg.Table table)

manifestDS

protected org.apache.spark.sql.Dataset<FileInfo> manifestDS(org.apache.iceberg.Table table,
                                                            java.util.Set<java.lang.Long> snapshotIds)

manifestListDS

protected org.apache.spark.sql.Dataset<FileInfo> manifestListDS(org.apache.iceberg.Table table)

manifestListDS

protected org.apache.spark.sql.Dataset<FileInfo> manifestListDS(org.apache.iceberg.Table table,
                                                                java.util.Set<java.lang.Long> snapshotIds)

statisticsFileDS

protected org.apache.spark.sql.Dataset<FileInfo> statisticsFileDS(org.apache.iceberg.Table table,
                                                                  java.util.Set<java.lang.Long> snapshotIds)

otherMetadataFileDS

protected org.apache.spark.sql.Dataset<FileInfo> otherMetadataFileDS(org.apache.iceberg.Table table)

allReachableOtherMetadataFileDS

protected org.apache.spark.sql.Dataset<FileInfo> allReachableOtherMetadataFileDS(org.apache.iceberg.Table table)

loadMetadataTable

protected org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> loadMetadataTable(org.apache.iceberg.Table table,
                                                                                   org.apache.iceberg.MetadataTableType type)

deleteFiles

protected org.apache.iceberg.spark.actions.BaseSparkAction.DeleteSummary deleteFiles(java.util.concurrent.ExecutorService executorService,
                                                                                     java.util.function.Consumer<java.lang.String> deleteFunc,
                                                                                     java.util.Iterator<FileInfo> files)

Deletes files and keeps track of how many files were removed for each file type.

Parameters:

executorService - an executor service to use for parallel deletes

deleteFunc - a delete func

files - an iterator of Spark rows of the structure (path: String, type: String)

Returns:

stats on which files were deleted

deleteFiles

protected org.apache.iceberg.spark.actions.BaseSparkAction.DeleteSummary deleteFiles(org.apache.iceberg.io.SupportsBulkOperations io,
                                                                                     java.util.Iterator<FileInfo> files)