Package io.delta.kernel

Class TransactionCommitResult

Object

io.delta.kernel.TransactionCommitResult

@Evolving
public class TransactionCommitResult
extends Object

Contains the result of a successful transaction commit. Returned by Transaction.commit(Engine, CloseableIterable).

Since:

3.2.0

Constructor Summary

Constructors

Constructor	Description
TransactionCommitResult(long version, List<PostCommitHook> postCommitHooks, TransactionReport transactionReport, Optional<SnapshotImpl> postCommitSnapshotOpt)

Method Summary

Modifier and Type	Method	Description
List<PostCommitHook>	getPostCommitHooks()	Operations for connector to trigger post-commit.
Optional<Snapshot>	getPostCommitSnapshot()	Return the snapshot at the committed version.
TransactionReport	getTransactionReport()
long	getVersion()	Contains the version of the transaction committed as.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TransactionCommitResult

public TransactionCommitResult(long version,
 List<PostCommitHook> postCommitHooks,
 TransactionReport transactionReport,
 Optional<SnapshotImpl> postCommitSnapshotOpt)

Method Details

getVersion

public long getVersion()

Contains the version of the transaction committed as.

Returns:

version the transaction is committed as.

getPostCommitHooks

public List<PostCommitHook> getPostCommitHooks()

Operations for connector to trigger post-commit.

Usage:

• Async: Call PostCommitHook.threadSafeInvoke(Engine) in separate thread.
• Sync: Direct call PostCommitHook.threadSafeInvoke(Engine) and block until operation ends.

Returns:

list of post-commit operations

getTransactionReport

public TransactionReport getTransactionReport()

Returns:

the report and metrics for this transaction

getPostCommitSnapshot

public Optional<Snapshot> getPostCommitSnapshot()

Return the snapshot at the committed version.

Currently, Kernel does not support getting the post-commit snapshot for transactions that experienced conflicts.