org.apache.iceberg.spark.actions

Class BaseMigrateTableSparkAction

java.lang.Object

org.apache.iceberg.spark.actions.BaseMigrateTableSparkAction

All Implemented Interfaces:

Action<MigrateTable,MigrateTable.Result>, MigrateTable

public class BaseMigrateTableSparkAction
extends java.lang.Object
implements 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

MigrateTable.Result

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.List<java.lang.String>	EXCLUDED_PROPERTIES
protected static java.lang.String	ICEBERG_METADATA_FOLDER
protected static java.lang.String	LOCATION

Constructor Summary

Constructors

Constructor and Description
BaseMigrateTableSparkAction(org.apache.spark.sql.SparkSession spark, org.apache.spark.sql.connector.catalog.CatalogPlugin sourceCatalog, org.apache.spark.sql.connector.catalog.Identifier sourceTableIdent)

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<org.apache.spark.sql.Row>	buildManifestFileDF(Table table)
protected org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>	buildManifestListDF(Table table)
protected org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>	buildOtherMetadataFileDF(Table table)
protected org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>	buildValidDataFileDF(Table table)
protected org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>	buildValidMetadataFileDF(Table table)
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.connector.catalog.StagingTableCatalog	destCatalog()
protected org.apache.spark.sql.connector.catalog.Identifier	destTableIdent()
protected java.util.Map<java.lang.String,java.lang.String>	destTableProps()
protected void	ensureNameMappingPresent(Table table)
MigrateTable.Result	execute() Executes this action.
protected java.lang.String	getMetadataLocation(Table table)
protected org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>	loadMetadataTable(Table table, MetadataTableType type)
protected JobGroupInfo	newJobGroupInfo(java.lang.String groupId, java.lang.String desc)
protected Table	newStaticTable(TableMetadata metadata, FileIO io)
ThisT	option(java.lang.String name, java.lang.String value) Configures this action with an extra option.
protected java.util.Map<java.lang.String,java.lang.String>	options()
ThisT	options(java.util.Map<java.lang.String,java.lang.String> newOptions) Configures this action with extra options.
protected MigrateTable	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()
MigrateTable	tableProperties(java.util.Map<java.lang.String,java.lang.String> properties) Sets table properties in the newly created Iceberg table.
MigrateTable	tableProperty(java.lang.String property, java.lang.String value) Sets a table property in the newly created Iceberg table.
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

Constructor Detail

BaseMigrateTableSparkAction

public BaseMigrateTableSparkAction(org.apache.spark.sql.SparkSession spark,
                                   org.apache.spark.sql.connector.catalog.CatalogPlugin sourceCatalog,
                                   org.apache.spark.sql.connector.catalog.Identifier sourceTableIdent)

Method Detail

self

protected MigrateTable self()

destCatalog

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

destTableIdent

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

tableProperties

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

Description copied from interface: MigrateTable

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

Specified by:

tableProperties in interface MigrateTable

Parameters:

properties - a map of properties to set

Returns:

this for method chaining

tableProperty

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

Description copied from interface: MigrateTable

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

Specified by:

tableProperty in interface MigrateTable

Parameters:

property - a table property name

value - a table property value

Returns:

this for method chaining

execute

public MigrateTable.Result execute()

Description copied from interface: Action

Executes this action.

Specified by:

execute in interface Action<MigrateTable,MigrateTable.Result>

Returns:

the result of this action

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(Table table)

getMetadataLocation

protected java.lang.String getMetadataLocation(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)

Description copied from interface: Action

Configures this action with an extra option.

Certain actions allow users to control internal details of their execution via options.

Specified by:

option in interface Action<ThisT,R>

Parameters:

name - an option name

value - an option value

Returns:

this for method chaining

options

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

Description copied from interface: Action

Configures this action with extra options.

Certain actions allow users to control internal details of their execution via options.

Specified by:

options in interface Action<ThisT,R>

Parameters:

newOptions - a map of extra options

Returns:

this for method chaining

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 Table newStaticTable(TableMetadata metadata,
                               FileIO io)

buildValidDataFileDF

protected org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> buildValidDataFileDF(Table table)

buildManifestFileDF

protected org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> buildManifestFileDF(Table table)

buildManifestListDF

protected org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> buildManifestListDF(Table table)

buildOtherMetadataFileDF

protected org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> buildOtherMetadataFileDF(Table table)

buildValidMetadataFileDF

protected org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> buildValidMetadataFileDF(Table table)

loadMetadataTable

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