Package org.apache.iceberg.spark.actions

Class ExpireSnapshotsSparkAction

java.lang.Object

org.apache.iceberg.spark.actions.ExpireSnapshotsSparkAction

All Implemented Interfaces:

Action<ExpireSnapshots,ExpireSnapshots.Result>, ExpireSnapshots

public class ExpireSnapshotsSparkAction
extends Object
implements ExpireSnapshots

An action that performs the same operation as ExpireSnapshots but uses Spark to determine the delta in files between the pre and post-expiration table metadata. All of the same restrictions of ExpireSnapshots also apply to this action.

This action first leverages ExpireSnapshots to expire snapshots and then uses metadata tables to find files that can be safely deleted. This is done by anti-joining two Datasets that contain all manifest and content files before and after the expiration. The snapshot expiration will be fully committed before any deletes are issued.

This operation performs a shuffle so the parallelism can be controlled through 'spark.sql.shuffle.partitions'.

Deletes are still performed locally after retrieving the results from the Spark executors.

Nested Class Summary

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

ExpireSnapshots.Result

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.apache.iceberg.relocated.com.google.common.base.Joiner	COMMA_JOINER
protected static final org.apache.iceberg.relocated.com.google.common.base.Splitter	COMMA_SPLITTER
protected static final String	FILE_PATH
protected static final String	LAST_MODIFIED
protected static final String	MANIFEST
protected static final String	MANIFEST_LIST
protected static final String	OTHERS
protected static final String	STATISTICS_FILES
static final String	STREAM_RESULTS
static final boolean	STREAM_RESULTS_DEFAULT

Method Summary

Modifier and Type	Method	Description
protected org.apache.spark.sql.Dataset<FileInfo>	allReachableOtherMetadataFileDS(Table table)
ExpireSnapshotsSparkAction	cleanExpiredMetadata(boolean clean)	Expires unused table metadata such as partition specs and schemas.
protected org.apache.spark.sql.Dataset<FileInfo>	contentFileDS(Table table)
protected org.apache.spark.sql.Dataset<FileInfo>	contentFileDS(Table table, Set<Long> snapshotIds)
protected org.apache.iceberg.spark.actions.BaseSparkAction.DeleteSummary	deleteFiles(ExecutorService executorService, Consumer<String> deleteFunc, 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(SupportsBulkOperations io, Iterator<FileInfo> files)
ExpireSnapshotsSparkAction	deleteWith(Consumer<String> newDeleteFunc)	Passes an alternative delete implementation that will be used for manifests, data and delete files.
ExpireSnapshots.Result	execute()	Executes this action.
ExpireSnapshotsSparkAction	executeDeleteWith(ExecutorService executorService)	Passes an alternative executor service that will be used for files removal.
org.apache.spark.sql.Dataset<FileInfo>	expireFiles()	Expires snapshots and commits the changes to the table, returning a Dataset of files to delete.
ExpireSnapshotsSparkAction	expireOlderThan(long timestampMillis)	Expires all snapshots older than the given timestamp.
ExpireSnapshotsSparkAction	expireSnapshotId(long snapshotId)	Expires a specific Snapshot identified by id.
protected org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>	loadMetadataTable(Table table, MetadataTableType type)
protected org.apache.spark.sql.Dataset<FileInfo>	manifestDS(Table table)
protected org.apache.spark.sql.Dataset<FileInfo>	manifestDS(Table table, Set<Long> snapshotIds)
protected org.apache.spark.sql.Dataset<FileInfo>	manifestListDS(Table table)
protected org.apache.spark.sql.Dataset<FileInfo>	manifestListDS(Table table, Set<Long> snapshotIds)
protected JobGroupInfo	newJobGroupInfo(String groupId, String desc)
protected Table	newStaticTable(String metadataFileLocation, FileIO io)
protected Table	newStaticTable(TableMetadata metadata, FileIO io)
ExpireSnapshotsSparkAction	option(String name, String value)
protected Map<String,String>	options()
ExpireSnapshotsSparkAction	options(Map<String,String> newOptions)
protected org.apache.spark.sql.Dataset<FileInfo>	otherMetadataFileDS(Table table)
ExpireSnapshotsSparkAction	retainLast(int numSnapshots)	Retains the most recent ancestors of the current snapshot.
protected ExpireSnapshotsSparkAction	self()
protected org.apache.spark.sql.SparkSession	spark()
protected org.apache.spark.api.java.JavaSparkContext	sparkContext()
protected org.apache.spark.sql.Dataset<FileInfo>	statisticsFileDS(Table table, Set<Long> snapshotIds)
protected <T> T	withJobGroupInfo(JobGroupInfo info, 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 Details

STREAM_RESULTS

public static final String STREAM_RESULTS

See Also:

• Constant Field Values

STREAM_RESULTS_DEFAULT

public static final boolean STREAM_RESULTS_DEFAULT

See Also:

• Constant Field Values

MANIFEST

protected static final String MANIFEST

See Also:

• Constant Field Values

MANIFEST_LIST

protected static final String MANIFEST_LIST

See Also:

• Constant Field Values

STATISTICS_FILES

protected static final String STATISTICS_FILES

See Also:

• Constant Field Values

OTHERS

protected static final String OTHERS

See Also:

• Constant Field Values

FILE_PATH

protected static final String FILE_PATH

See Also:

• Constant Field Values

LAST_MODIFIED

protected static final 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 Details

self

protected ExpireSnapshotsSparkAction self()

executeDeleteWith

public ExpireSnapshotsSparkAction executeDeleteWith(ExecutorService executorService)

Description copied from interface: ExpireSnapshots

Passes an alternative executor service that will be used for files removal. This service will only be used if a custom delete function is provided by ExpireSnapshots.deleteWith(Consumer) or if the FileIO does not support bulk deletes. Otherwise, parallelism should be controlled by the IO specific deleteFiles method.

If this method is not called and bulk deletes are not supported, unnecessary manifests and content files will still be deleted in the current thread.

Identical to ExpireSnapshots.executeDeleteWith(ExecutorService)

Specified by:

executeDeleteWith in interface ExpireSnapshots

Parameters:

executorService - the service to use

Returns:

this for method chaining

expireSnapshotId

public ExpireSnapshotsSparkAction expireSnapshotId(long snapshotId)

Description copied from interface: ExpireSnapshots

Expires a specific Snapshot identified by id.

Identical to ExpireSnapshots.expireSnapshotId(long)

Specified by:

expireSnapshotId in interface ExpireSnapshots

Parameters:

snapshotId - id of the snapshot to expire

Returns:

this for method chaining

expireOlderThan

public ExpireSnapshotsSparkAction expireOlderThan(long timestampMillis)

Description copied from interface: ExpireSnapshots

Expires all snapshots older than the given timestamp.

Identical to ExpireSnapshots.expireOlderThan(long)

Specified by:

expireOlderThan in interface ExpireSnapshots

Parameters:

timestampMillis - a long timestamp, as returned by System.currentTimeMillis()

Returns:

this for method chaining

retainLast

public ExpireSnapshotsSparkAction retainLast(int numSnapshots)

Description copied from interface: ExpireSnapshots

Retains the most recent ancestors of the current snapshot.

If a snapshot would be expired because it is older than the expiration timestamp, but is one of the numSnapshots most recent ancestors of the current state, it will be retained. This will not cause snapshots explicitly identified by id from expiring.

Identical to ExpireSnapshots.retainLast(int)

Specified by:

retainLast in interface ExpireSnapshots

Parameters:

numSnapshots - the number of snapshots to retain

Returns:

this for method chaining

deleteWith

public ExpireSnapshotsSparkAction deleteWith(Consumer<String> newDeleteFunc)

Description copied from interface: ExpireSnapshots

Passes an alternative delete implementation that will be used for manifests, data and delete files.

Manifest files that are no longer used by valid snapshots will be deleted. Content files that were marked as logically deleted by snapshots that are expired will be deleted as well.

If this method is not called, unnecessary manifests and content files will still be deleted.

Identical to ExpireSnapshots.deleteWith(Consumer)

Specified by:

deleteWith in interface ExpireSnapshots

Parameters:

newDeleteFunc - a function that will be called to delete manifests and data files

Returns:

this for method chaining

cleanExpiredMetadata

public ExpireSnapshotsSparkAction cleanExpiredMetadata(boolean clean)

Description copied from interface: ExpireSnapshots

Expires unused table metadata such as partition specs and schemas.

Metadata such as partition specs or schemas that are no longer referenced by snapshots will be removed.

Identical to ExpireSnapshots.cleanExpiredMetadata(boolean)

Specified by:

cleanExpiredMetadata in interface ExpireSnapshots

Parameters:

clean - remove unused partition specs, schemas, or other metadata when true

Returns:

this for method chaining

expireFiles

public org.apache.spark.sql.Dataset<FileInfo> expireFiles()

Expires snapshots and commits the changes to the table, returning a Dataset of files to delete.

This does not delete data files. To delete data files, run execute().

This may be called before or after execute() to return the expired files.

Returns:

a Dataset of files that are no longer referenced by the table

execute

public ExpireSnapshots.Result execute()

Description copied from interface: Action

Executes this action.

Specified by:

execute in interface Action<ExpireSnapshots,ExpireSnapshots.Result>

Returns:

the result of this action

spark

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

sparkContext

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

option

public ExpireSnapshotsSparkAction option(String name,
 String value)

options

public ExpireSnapshotsSparkAction options(Map<String,String> newOptions)

options

protected Map<String,String> options()

withJobGroupInfo

protected <T> T withJobGroupInfo(JobGroupInfo info,
 Supplier<T> supplier)

newJobGroupInfo

protected JobGroupInfo newJobGroupInfo(String groupId,
 String desc)

newStaticTable

protected Table newStaticTable(TableMetadata metadata,
 FileIO io)

newStaticTable

protected Table newStaticTable(String metadataFileLocation,
 FileIO io)

contentFileDS

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

contentFileDS

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

manifestDS

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

manifestDS

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

manifestListDS

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

manifestListDS

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

statisticsFileDS

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

otherMetadataFileDS

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

allReachableOtherMetadataFileDS

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

loadMetadataTable

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

deleteFiles

protected org.apache.iceberg.spark.actions.BaseSparkAction.DeleteSummary deleteFiles(ExecutorService executorService,
 Consumer<String> deleteFunc,
 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(SupportsBulkOperations io,
 Iterator<FileInfo> files)