io.delta.standalone.actions

Class RemoveFile

Object

io.delta.standalone.actions.RemoveFile

All Implemented Interfaces:

Action, FileAction

public final class RemoveFile
extends Object
implements FileAction

Logical removal of a given file from the reservoir. Acts as a tombstone before a file is deleted permanently.

Users should only instantiate RemoveFile instances using one of the various AddFile.remove() methods. Users should use an AddFile instance read from the Delta Log since AddFile paths may be updated during OptimisticTransaction.commit(java.lang.Iterable<T>, io.delta.standalone.Operation, java.lang.String).

Note that for protocol compatibility reasons, the fields partitionValues, size, and tags are only present when the extendedFileMetadata flag is true. New writers should generally be setting this flag, but old writers (and FSCK) won't, so readers must check this flag before attempting to consume those values.

See Also:

Delta Transaction Log Protocol: Add File and Remove File

Constructor Summary

Constructors

Constructor and Description
RemoveFile(String path, java.util.Optional<Long> deletionTimestamp, boolean dataChange, boolean extendedFileMetadata, java.util.Map<String,String> partitionValues, java.util.Optional<Long> size, java.util.Map<String,String> tags) Deprecated. RemoveFile should be created from AddFile.remove() instead.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
java.util.Optional<Long>	getDeletionTimestamp()
java.util.Map<String,String>	getPartitionValues()
String	getPath()
java.util.Optional<Long>	getSize()
java.util.Map<String,String>	getTags()
int	hashCode()
boolean	isDataChange()
boolean	isExtendedFileMetadata()

Methods inherited from class Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoveFile

@Deprecated
public RemoveFile(@Nonnull
                              String path,
                              @Nonnull
                              java.util.Optional<Long> deletionTimestamp,
                              boolean dataChange,
                              boolean extendedFileMetadata,
                              @Nullable
                              java.util.Map<String,String> partitionValues,
                              @Nonnull
                              java.util.Optional<Long> size,
                              @Nullable
                              java.util.Map<String,String> tags)

Deprecated. RemoveFile should be created from AddFile.remove() instead.

Users should not construct RemoveFiles themselves, and should instead use one of the various AddFile.remove() methods to instantiate the correct RemoveFile for a given AddFile instance.

Method Detail

getPath

public String getPath()

Specified by:

getPath in interface FileAction

Returns:

the relative path or the absolute path that should be removed from the table. If it's a relative path, it's relative to the root of the table. Note: the path is encoded and should be decoded by new java.net.URI(path) when using it.

getDeletionTimestamp

public java.util.Optional<Long> getDeletionTimestamp()

Returns:

the time that this file was deleted as milliseconds since the epoch

isDataChange

public boolean isDataChange()

Specified by:

isDataChange in interface FileAction

Returns:

whether any data was changed as a result of this file being removed. When false the records in the removed file must be contained in one or more add actions in the same version

isExtendedFileMetadata

public boolean isExtendedFileMetadata()

Returns:

true if the fields partitionValues, size, and tags are present

getPartitionValues

@Nullable
public java.util.Map<String,String> getPartitionValues()

Returns:

an unmodifiable Map from partition column to value for this file. Partition values are stored as strings, using the following formats. An empty string for any type translates to a null partition value.

See Also:

Delta Protocol Partition Value Serialization

getSize

public java.util.Optional<Long> getSize()

Returns:

the size of this file in bytes

getTags

@Nullable
public java.util.Map<String,String> getTags()

Returns:

an unmodifiable Map containing metadata about this file

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object