org.apache.iceberg.spark.actions

Class DeleteOrphanFilesSparkAction

java.lang.Object

org.apache.iceberg.spark.actions.DeleteOrphanFilesSparkAction

All Implemented Interfaces:

Action<DeleteOrphanFiles,DeleteOrphanFiles.Result>, DeleteOrphanFiles

public class DeleteOrphanFilesSparkAction
extends java.lang.Object
implements DeleteOrphanFiles

An action that removes orphan metadata, data and delete files by listing a given location and comparing the actual files in that location with content and metadata files referenced by all valid snapshots. The location must be accessible for listing via the Hadoop FileSystem.

By default, this action cleans up the table location returned by Table.location() and removes unreachable files that are older than 3 days using Table.io(). The behavior can be modified by passing a custom location to location and a custom timestamp to olderThan(long). For example, someone might point this action to the data folder to clean up only orphan data files.

Configure an alternative delete method using deleteWith(Consumer).

For full control of the set of files being evaluated, use the compareToFileList(Dataset) argument. This skips the directory listing - any files in the dataset provided which are not found in table metadata will be deleted, using the same Table.location() and olderThan(long) filtering as above.

Note: It is dangerous to call this action with a short retention interval as it might corrupt the state of the table if another operation is writing at the same time.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeleteOrphanFilesSparkAction.FileURI

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

DeleteOrphanFiles.PrefixMismatchMode, DeleteOrphanFiles.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.lang.String	FILE_PATH
protected static java.lang.String	LAST_MODIFIED
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 org.apache.spark.sql.Dataset<FileInfo>	allReachableOtherMetadataFileDS(Table table)
DeleteOrphanFilesSparkAction	compareToFileList(org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> files)
protected org.apache.spark.sql.Dataset<FileInfo>	contentFileDS(Table table)
protected org.apache.spark.sql.Dataset<FileInfo>	contentFileDS(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(SupportsBulkOperations io, java.util.Iterator<FileInfo> files)
DeleteOrphanFilesSparkAction	deleteWith(java.util.function.Consumer<java.lang.String> newDeleteFunc) Passes an alternative delete implementation that will be used for orphan files.
DeleteOrphanFilesSparkAction	equalAuthorities(java.util.Map<java.lang.String,java.lang.String> newEqualAuthorities) Passes authorities that should be considered equal.
DeleteOrphanFilesSparkAction	equalSchemes(java.util.Map<java.lang.String,java.lang.String> newEqualSchemes) Passes schemes that should be considered equal.
DeleteOrphanFiles.Result	execute() Executes this action.
DeleteOrphanFilesSparkAction	executeDeleteWith(java.util.concurrent.ExecutorService executorService) Passes an alternative executor service that will be used for removing orphaned files.
protected org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>	loadMetadataTable(Table table, MetadataTableType type)
DeleteOrphanFilesSparkAction	location(java.lang.String newLocation) Passes a location which should be scanned for orphan files.
protected org.apache.spark.sql.Dataset<FileInfo>	manifestDS(Table table)
protected org.apache.spark.sql.Dataset<FileInfo>	manifestDS(Table table, java.util.Set<java.lang.Long> snapshotIds)
protected org.apache.spark.sql.Dataset<FileInfo>	manifestListDS(Table table)
protected org.apache.spark.sql.Dataset<FileInfo>	manifestListDS(Table table, java.util.Set<java.lang.Long> snapshotIds)
protected JobGroupInfo	newJobGroupInfo(java.lang.String groupId, java.lang.String desc)
protected Table	newStaticTable(TableMetadata metadata, FileIO io)
DeleteOrphanFilesSparkAction	olderThan(long newOlderThanTimestamp) Removes orphan files only if they are older than the given timestamp.
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(Table table)
DeleteOrphanFilesSparkAction	prefixMismatchMode(DeleteOrphanFiles.PrefixMismatchMode newPrefixMismatchMode) Passes a prefix mismatch mode that determines how this action should handle situations when the metadata references files that match listed/provided files except for authority/scheme.
protected DeleteOrphanFilesSparkAction	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, java.util.Set<java.lang.Long> snapshotIds)
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

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 DeleteOrphanFilesSparkAction self()

executeDeleteWith

public DeleteOrphanFilesSparkAction executeDeleteWith(java.util.concurrent.ExecutorService executorService)

Description copied from interface: DeleteOrphanFiles

Passes an alternative executor service that will be used for removing orphaned files. This service will only be used if a custom delete function is provided by DeleteOrphanFiles.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, orphaned manifests and data files will still be deleted in the current thread.

Specified by:

executeDeleteWith in interface DeleteOrphanFiles

Parameters:

executorService - the service to use

Returns:

this for method chaining

prefixMismatchMode

public DeleteOrphanFilesSparkAction prefixMismatchMode(DeleteOrphanFiles.PrefixMismatchMode newPrefixMismatchMode)

Description copied from interface: DeleteOrphanFiles

Passes a prefix mismatch mode that determines how this action should handle situations when the metadata references files that match listed/provided files except for authority/scheme.

Possible values are "ERROR", "IGNORE", "DELETE". The default mismatch mode is "ERROR", which means an exception is thrown whenever there is a mismatch in authority/scheme. It's the recommended mismatch mode and should be changed only in some rare circumstances. If there is a mismatch, use DeleteOrphanFiles.equalSchemes(Map) and DeleteOrphanFiles.equalAuthorities(Map) to resolve conflicts by providing equivalent schemes and authorities. If it is impossible to determine whether the conflicting authorities/schemes are equal, set the prefix mismatch mode to "IGNORE" to skip files with mismatches. If you have manually inspected all conflicting authorities/schemes, provided equivalent schemes/authorities and are absolutely confident the remaining ones are different, set the prefix mismatch mode to "DELETE" to consider files with mismatches as orphan. It will be impossible to recover files after deletion, so the "DELETE" prefix mismatch mode must be used with extreme caution.

Specified by:

prefixMismatchMode in interface DeleteOrphanFiles

Parameters:

newPrefixMismatchMode - mode for handling prefix mismatches

Returns:

this for method chaining

equalSchemes

public DeleteOrphanFilesSparkAction equalSchemes(java.util.Map<java.lang.String,java.lang.String> newEqualSchemes)

Description copied from interface: DeleteOrphanFiles

Passes schemes that should be considered equal.

The key may include a comma-separated list of schemes. For instance, Map("s3a,s3,s3n", "s3").

Specified by:

equalSchemes in interface DeleteOrphanFiles

Parameters:

newEqualSchemes - list of equal schemes

Returns:

this for method chaining

equalAuthorities

public DeleteOrphanFilesSparkAction equalAuthorities(java.util.Map<java.lang.String,java.lang.String> newEqualAuthorities)

Description copied from interface: DeleteOrphanFiles

Passes authorities that should be considered equal.

The key may include a comma-separate list of authorities. For instance, Map("s1name,s2name", "servicename").

Specified by:

equalAuthorities in interface DeleteOrphanFiles

Parameters:

newEqualAuthorities - list of equal authorities

Returns:

this for method chaining

location

public DeleteOrphanFilesSparkAction location(java.lang.String newLocation)

Description copied from interface: DeleteOrphanFiles

Passes a location which should be scanned for orphan files.

If not set, the root table location will be scanned potentially removing both orphan data and metadata files.

Specified by:

location in interface DeleteOrphanFiles

Parameters:

newLocation - the location where to look for orphan files

Returns:

this for method chaining

olderThan

public DeleteOrphanFilesSparkAction olderThan(long newOlderThanTimestamp)

Description copied from interface: DeleteOrphanFiles

Removes orphan files only if they are older than the given timestamp.

This is a safety measure to avoid removing files that are being added to the table. For example, there may be a concurrent operation adding new files while this action searches for orphan files. New files may not be referenced by the metadata yet but they are not orphan.

If not set, defaults to a timestamp 3 days ago.

Specified by:

olderThan in interface DeleteOrphanFiles

Parameters:

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

Returns:

this for method chaining

deleteWith

public DeleteOrphanFilesSparkAction deleteWith(java.util.function.Consumer<java.lang.String> newDeleteFunc)

Description copied from interface: DeleteOrphanFiles

Passes an alternative delete implementation that will be used for orphan files.

This method allows users to customize the delete function. For example, one may set a custom delete func and collect all orphan files into a set instead of physically removing them.

If not set, defaults to using the table's io implementation.

Specified by:

deleteWith in interface DeleteOrphanFiles

Parameters:

newDeleteFunc - a function that will be called to delete files

Returns:

this for method chaining

compareToFileList

public DeleteOrphanFilesSparkAction compareToFileList(org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> files)

execute

public DeleteOrphanFiles.Result execute()

Description copied from interface: Action

Executes this action.

Specified by:

execute in interface Action<DeleteOrphanFiles,DeleteOrphanFiles.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 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 Table newStaticTable(TableMetadata metadata,
                               FileIO io)

contentFileDS

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

contentFileDS

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

manifestDS

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

manifestDS

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

manifestListDS

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

manifestListDS

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

statisticsFileDS

protected org.apache.spark.sql.Dataset<FileInfo> statisticsFileDS(Table table,
                                                                  java.util.Set<java.lang.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(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(SupportsBulkOperations io,
                                                                                     java.util.Iterator<FileInfo> files)