io.delta.standalone.actions

Class AddFile

Object

io.delta.standalone.actions.AddFile

All Implemented Interfaces:

Action, FileAction

public final class AddFile
extends Object
implements FileAction

Represents an action that adds a new file to the table. The path of a file acts as the primary key for the entry in the set of files.

Note: since actions within a given Delta file are not guaranteed to be applied in order, it is not valid for multiple file operations with the same path to exist in a single version.

See Also:

Delta Transaction Log Protocol: Add File and Remove File

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AddFile.Builder Builder class for AddFile.

Constructor Summary

Constructors

Constructor and Description
AddFile(String path, java.util.Map<String,String> partitionValues, long size, long modificationTime, boolean dataChange, String stats, java.util.Map<String,String> tags)

Method Summary

Modifier and Type	Method and Description
static AddFile.Builder	builder(String path, java.util.Map<String,String> partitionValues, long size, long modificationTime, boolean dataChange)
boolean	equals(Object o)
long	getModificationTime()
java.util.Map<String,String>	getPartitionValues()
String	getPath()
long	getSize()
String	getStats()
java.util.Map<String,String>	getTags()
int	hashCode()
boolean	isDataChange()
RemoveFile	remove()
RemoveFile	remove(boolean dataChange)
RemoveFile	remove(long deletionTimestamp)
RemoveFile	remove(long deletionTimestamp, boolean dataChange)

Methods inherited from class Object

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

Constructor Detail

AddFile

public AddFile(@Nonnull
               String path,
               @Nonnull
               java.util.Map<String,String> partitionValues,
               long size,
               long modificationTime,
               boolean dataChange,
               @Nullable
               String stats,
               @Nullable
               java.util.Map<String,String> tags)

Method Detail

remove

@Nonnull
public RemoveFile remove()

Returns:

the corresponding RemoveFile for this file, instantiated with deletionTimestamp = System.currentTimeMillis()

remove

@Nonnull
public RemoveFile remove(long deletionTimestamp)

Returns:

the corresponding RemoveFile for this file, instantiated with the given deletionTimestamp

remove

@Nonnull
public RemoveFile remove(boolean dataChange)

Returns:

the corresponding RemoveFile for this file, instantiated with the given dataChange flag

remove

@Nonnull
public RemoveFile remove(long deletionTimestamp,
                                  boolean dataChange)

Returns:

the corresponding RemoveFile for this file, instantiated with the given deletionTimestamp value and dataChange flag

getPath

@Nonnull
public String getPath()

Specified by:

getPath in interface FileAction

Returns:

the relative path or the absolute path that should be added to 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.

getPartitionValues

@Nonnull
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 long getSize()

Returns:

the size of this file in bytes

getModificationTime

public long getModificationTime()

Returns:

the time that this file was last modified or created, 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 created. When false the file must already be present in the table or the records in the added file must be contained in one or more remove actions in the same version

getStats

@Nullable
public String getStats()

Returns:

statistics (for example: count, min/max values for columns) about the data in this file as serialized JSON

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

builder

public static AddFile.Builder builder(String path,
                                      java.util.Map<String,String> partitionValues,
                                      long size,
                                      long modificationTime,
                                      boolean dataChange)

Returns:

a new AddFile.Builder