io.delta.standalone.actions

Class CommitInfo

Object

io.delta.standalone.actions.CommitInfo

All Implemented Interfaces:

Action

public class CommitInfo
extends Object
implements Action

Holds provenance information about changes to the table. This CommitInfo is not stored in the checkpoint and has reduced compatibility guarantees. Information stored in it is best effort (i.e. can be falsified by a writer).

See Also:

Delta Transaction Log Protocol: Commit Provenance Information

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
CommitInfo(java.util.Optional<Long> version, java.sql.Timestamp timestamp, java.util.Optional<String> userId, java.util.Optional<String> userName, String operation, java.util.Map<String,String> operationParameters, java.util.Optional<JobInfo> jobInfo, java.util.Optional<NotebookInfo> notebookInfo, java.util.Optional<String> clusterId, java.util.Optional<Long> readVersion, java.util.Optional<String> isolationLevel, java.util.Optional<Boolean> isBlindAppend, java.util.Optional<java.util.Map<String,String>> operationMetrics, java.util.Optional<String> userMetadata)
CommitInfo(java.util.Optional<Long> version, java.sql.Timestamp timestamp, java.util.Optional<String> userId, java.util.Optional<String> userName, String operation, java.util.Map<String,String> operationParameters, java.util.Optional<JobInfo> jobInfo, java.util.Optional<NotebookInfo> notebookInfo, java.util.Optional<String> clusterId, java.util.Optional<Long> readVersion, java.util.Optional<String> isolationLevel, java.util.Optional<Boolean> isBlindAppend, java.util.Optional<java.util.Map<String,String>> operationMetrics, java.util.Optional<String> userMetadata, java.util.Optional<String> engineInfo)

Method Summary

Modifier and Type	Method and Description
static CommitInfo.Builder	builder()
boolean	equals(Object o)
java.util.Optional<String>	getClusterId()
java.util.Optional<String>	getEngineInfo()
java.util.Optional<Boolean>	getIsBlindAppend()
java.util.Optional<String>	getIsolationLevel()
java.util.Optional<JobInfo>	getJobInfo()
java.util.Optional<NotebookInfo>	getNotebookInfo()
String	getOperation()
java.util.Optional<java.util.Map<String,String>>	getOperationMetrics()
java.util.Map<String,String>	getOperationParameters()
java.util.Optional<Long>	getReadVersion()
java.sql.Timestamp	getTimestamp()
java.util.Optional<String>	getUserId()
java.util.Optional<String>	getUserMetadata()
java.util.Optional<String>	getUserName()
java.util.Optional<Long>	getVersion()
int	hashCode()

Methods inherited from class Object

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

Constructor Detail

CommitInfo

public CommitInfo(@Nonnull
                  java.util.Optional<Long> version,
                  @Nullable
                  java.sql.Timestamp timestamp,
                  @Nonnull
                  java.util.Optional<String> userId,
                  @Nonnull
                  java.util.Optional<String> userName,
                  @Nullable
                  String operation,
                  @Nullable
                  java.util.Map<String,String> operationParameters,
                  @Nonnull
                  java.util.Optional<JobInfo> jobInfo,
                  @Nonnull
                  java.util.Optional<NotebookInfo> notebookInfo,
                  @Nonnull
                  java.util.Optional<String> clusterId,
                  @Nonnull
                  java.util.Optional<Long> readVersion,
                  @Nonnull
                  java.util.Optional<String> isolationLevel,
                  @Nonnull
                  java.util.Optional<Boolean> isBlindAppend,
                  @Nonnull
                  java.util.Optional<java.util.Map<String,String>> operationMetrics,
                  @Nonnull
                  java.util.Optional<String> userMetadata)

CommitInfo

public CommitInfo(@Nonnull
                  java.util.Optional<Long> version,
                  @Nullable
                  java.sql.Timestamp timestamp,
                  @Nonnull
                  java.util.Optional<String> userId,
                  @Nonnull
                  java.util.Optional<String> userName,
                  @Nullable
                  String operation,
                  @Nullable
                  java.util.Map<String,String> operationParameters,
                  @Nonnull
                  java.util.Optional<JobInfo> jobInfo,
                  @Nonnull
                  java.util.Optional<NotebookInfo> notebookInfo,
                  @Nonnull
                  java.util.Optional<String> clusterId,
                  @Nonnull
                  java.util.Optional<Long> readVersion,
                  @Nonnull
                  java.util.Optional<String> isolationLevel,
                  @Nonnull
                  java.util.Optional<Boolean> isBlindAppend,
                  @Nonnull
                  java.util.Optional<java.util.Map<String,String>> operationMetrics,
                  @Nonnull
                  java.util.Optional<String> userMetadata,
                  @Nonnull
                  java.util.Optional<String> engineInfo)

Method Detail

getVersion

@Nonnull
public java.util.Optional<Long> getVersion()

Returns:

the log version for this commit

getTimestamp

@Nullable
public java.sql.Timestamp getTimestamp()

Returns:

the time the files in this commit were committed

getUserId

@Nonnull
public java.util.Optional<String> getUserId()

Returns:

the userId of the user who committed this file

getUserName

@Nonnull
public java.util.Optional<String> getUserName()

Returns:

the userName of the user who committed this file

getOperation

@Nullable
public String getOperation()

Returns:

the type of operation for this commit. e.g. "WRITE"

getOperationParameters

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

Returns:

any relevant operation parameters. e.g. "mode", "partitionBy"

getJobInfo

@Nonnull
public java.util.Optional<JobInfo> getJobInfo()

Returns:

the JobInfo for this commit

getNotebookInfo

@Nonnull
public java.util.Optional<NotebookInfo> getNotebookInfo()

Returns:

the NotebookInfo for this commit

getClusterId

@Nonnull
public java.util.Optional<String> getClusterId()

Returns:

the ID of the cluster used to generate this commit

getReadVersion

@Nonnull
public java.util.Optional<Long> getReadVersion()

Returns:

the version that the transaction used to generate this commit is reading from

getIsolationLevel

@Nonnull
public java.util.Optional<String> getIsolationLevel()

Returns:

the isolation level at which this commit was generated

getIsBlindAppend

@Nonnull
public java.util.Optional<Boolean> getIsBlindAppend()

Returns:

whether this commit has blindly appended without caring about existing files

getOperationMetrics

@Nonnull
public java.util.Optional<java.util.Map<String,String>> getOperationMetrics()

Returns:

any operation metrics calculated

getUserMetadata

@Nonnull
public java.util.Optional<String> getUserMetadata()

Returns:

any additional user metadata

getEngineInfo

@Nonnull
public java.util.Optional<String> getEngineInfo()

Returns:

the engineInfo of the engine that performed this commit. It should be of the form "{engineName}/{engineVersion} Delta-Standalone/{deltaStandaloneVersion}"

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

builder

public static CommitInfo.Builder builder()

Returns:

a new CommitInfo.Builder